bulkrax 4.3.0 → 5.0.0

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

@@ -29,7 +29,7 @@
 
   <%= form.input :export_source_importer,
     label: t('bulkrax.exporter.labels.importer'),
-    # required: true,
+    required: true,
     prompt: 'Select from the list',
     label_html: { class: 'importer export-source-option hidden' },
     input_html: { class: 'importer export-source-option hidden' },
@@ -38,7 +38,7 @@
   <%= form.input :export_source_collection,
     prompt: 'Start typing ...',
     label: t('bulkrax.exporter.labels.collection'),
-    # required: true,
+    required: true,
     placeholder: @collection&.title&.first,
     label_html: { class: 'collection export-source-option hidden' },
     input_html: {
@@ -52,7 +52,7 @@
 
   <%= form.input :export_source_worktype,
     label: t('bulkrax.exporter.labels.worktype'),
-    # required: true,
+    required: true,
     prompt: 'Select from the list',
     label_html: { class: 'worktype export-source-option hidden' },
     input_html: { class: 'worktype export-source-option hidden' },

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

@@ -14,7 +14,7 @@
       <% entries.each do |e| %>
         <% entry_path = item.class.to_s.include?('Importer') ? bulkrax.importer_entry_path(item.id, e.id) : bulkrax.exporter_entry_path(item.id, e.id) %>
         <tr>
-          <td><%= link_to e.identifier, bulkrax.importer_entry_path(item.id, e.id) %></td>
+          <td><%= link_to e.identifier, entry_path %></td>
           <td><%= e.id %></td>
           <% if e.status == "Complete" %>
             <td><span class="glyphicon glyphicon-ok" style="color: green;"></span> <%= e.status %></td>
@@ -24,12 +24,12 @@
             <td><span class="glyphicon glyphicon-remove" style="color: <%= e.status == 'Deleted' ? 'green' : 'red' %>;"></span> <%= e.status %></td>
           <% end %>
           <% if e.last_error.present? %>
-            <td><%= link_to e.last_error.dig("error_class"), bulkrax.importer_entry_path(item.id, e.id) %></td>
+            <td><%= link_to e.last_error.dig("error_class"), entry_path %></td>
           <% else %>
             <td></td>
           <% end %>
           <td><%= e.status_at %></td>
-          <td><%= link_to raw('<span class="glyphicon glyphicon-info-sign"></span>'), bulkrax.importer_entry_path(item.id, e.id) %></td>
+          <td><%= link_to raw('<span class="glyphicon glyphicon-info-sign"></span>'), entry_path %></td>
         </tr>
       <% end %>
     </tbody>

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

@@ -1,6 +1,10 @@
-<%= menu.nav_link(bulkrax.importers_path) do %>
-  <span class="fa fa-cloud-upload" aria-hidden="true"></span> <span class="sidebar-action-text"><%= t('bulkrax.admin.sidebar.importers') %></span>
+<% if current_ability.can_import_works? %>
+  <%= menu.nav_link(bulkrax.importers_path) 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) do %>
+    <span class="fa fa-cloud-download" aria-hidden="true"></span> <span class="sidebar-action-text"><%= t('bulkrax.admin.sidebar.exporters') %></span>
+  <% end %>
 <% end %>
-<%= menu.nav_link(bulkrax.exporters_path) do %>
-  <span class="fa fa-cloud-download" aria-hidden="true"></span> <span class="sidebar-action-text"><%= t('bulkrax.admin.sidebar.exporters') %></span>
-<% end %>

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

@@ -1,19 +1,30 @@
-<li class="h5"><%= t('hyrax.admin.sidebar.repository_objects') %></li>
+<li class="h5 nav-item"><%= t('hyrax.admin.sidebar.repository_objects') %></li>
 
 <%= menu.nav_link(hyrax.my_collections_path,
+                  class: "nav-link",
+                  onclick: "dontChangeAccordion(event);",
                   also_active_for: hyrax.dashboard_collections_path) do %>
   <span class="fa fa-folder-open" aria-hidden="true"></span> <span class="sidebar-action-text"><%= t('hyrax.admin.sidebar.collections') %></span>
 <% end %>
 
 <%= menu.nav_link(hyrax.my_works_path,
+                  class: "nav-link",
+                  onclick: "dontChangeAccordion(event);",
                   also_active_for: hyrax.dashboard_works_path) do %>
   <span class="fa fa-file" aria-hidden="true"></span> <span class="sidebar-action-text"><%= t('hyrax.admin.sidebar.works') %></span>
 <% end %>
 
-<%= menu.nav_link(bulkrax.importers_path) do %>
-  <span class="fa fa-cloud-upload" aria-hidden="true"></span> <span class="sidebar-action-text"><%= t('bulkrax.admin.sidebar.importers') %></span>
-<% end %>
-
-<%= menu.nav_link(bulkrax.exporters_path) do %>
-  <span class="fa fa-cloud-download" aria-hidden="true"></span> <span class="sidebar-action-text"><%= t('bulkrax.admin.sidebar.exporters') %></span>
+<% if ::Hyrax::DashboardController&.respond_to?(:sidebar_partials) %>
+  <%= render 'hyrax/dashboard/sidebar/menu_partials', menu: menu, section: :repository_content %>
+<% else %>
+  <% if current_ability.can_import_works? %>
+    <%= menu.nav_link(bulkrax.importers_path) 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) do %>
+      <span class="fa fa-cloud-download" aria-hidden="true"></span> <span class="sidebar-action-text"><%= t('bulkrax.admin.sidebar.exporters') %></span>
+    <% end %>
+  <% end %>
 <% end %>

data/db/migrate/20211203195233_rename_children_counters_to_relationships.rb

@@ -1,4 +1,4 @@
-class RenameChildrenCountersToRelationships < ActiveRecord::Migration[5.2]
+class RenameChildrenCountersToRelationships < ActiveRecord::Migration[5.1]
   def change
     rename_column :bulkrax_importer_runs, :processed_children, :processed_relationships unless column_exists?(:bulkrax_importer_runs, :processed_relationships)
     rename_column :bulkrax_importer_runs, :failed_children, :failed_relationships unless column_exists?(:bulkrax_importer_runs, :failed_relationships)

data/db/migrate/20211220195027_add_file_set_counters_to_importer_runs.rb

@@ -1,4 +1,4 @@
-class AddFileSetCountersToImporterRuns < ActiveRecord::Migration[5.2]
+class AddFileSetCountersToImporterRuns < ActiveRecord::Migration[5.1]
   def change
     add_column :bulkrax_importer_runs, :processed_file_sets, :integer, default: 0 unless column_exists?(:bulkrax_importer_runs, :processed_file_sets)
     add_column :bulkrax_importer_runs, :failed_file_sets, :integer, default: 0 unless column_exists?(:bulkrax_importer_runs, :failed_file_sets)

data/db/migrate/20220118001339_add_import_attempts_to_entries.rb

@@ -1,4 +1,4 @@
-class AddImportAttemptsToEntries < ActiveRecord::Migration[5.2]
+class AddImportAttemptsToEntries < ActiveRecord::Migration[5.1]
   def change
     add_column :bulkrax_entries, :import_attempts, :integer, default: 0 unless column_exists?(:bulkrax_entries, :import_attempts)
   end

data/db/migrate/20220119213325_add_work_counters_to_importer_runs.rb

@@ -1,4 +1,4 @@
-class AddWorkCountersToImporterRuns < ActiveRecord::Migration[5.2]
+class AddWorkCountersToImporterRuns < ActiveRecord::Migration[5.1]
   def change
     add_column :bulkrax_importer_runs, :processed_works, :integer, default: 0 unless column_exists?(:bulkrax_importer_runs, :processed_works)
     add_column :bulkrax_importer_runs, :failed_works, :integer, default: 0 unless column_exists?(:bulkrax_importer_runs, :failed_works)

data/db/migrate/20220301001839_create_bulkrax_pending_relationships.rb

@@ -1,4 +1,4 @@
-class CreateBulkraxPendingRelationships < ActiveRecord::Migration[5.2]
+class CreateBulkraxPendingRelationships < ActiveRecord::Migration[5.1]
   def change
     unless table_exists?(:bulkrax_pending_relationships)
       create_table :bulkrax_pending_relationships do |t|

data/db/migrate/20220303212810_add_order_to_bulkrax_pending_relationships.rb

@@ -1,4 +1,4 @@
-class AddOrderToBulkraxPendingRelationships < ActiveRecord::Migration[5.2]
+class AddOrderToBulkraxPendingRelationships < ActiveRecord::Migration[5.1]
   def change
     add_column :bulkrax_pending_relationships, :order, :integer, default: 0 unless column_exists?(:bulkrax_pending_relationships, :order)
   end

data/db/migrate/20220412233954_add_include_thumbnails_to_bulkrax_exporters.rb

@@ -1,4 +1,4 @@
-class AddIncludeThumbnailsToBulkraxExporters < ActiveRecord::Migration[5.2]
+class AddIncludeThumbnailsToBulkraxExporters < ActiveRecord::Migration[5.1]
   def change
     add_column :bulkrax_exporters, :include_thumbnails, :boolean, default: false unless column_exists?(:bulkrax_exporters, :include_thumbnails)
   end

data/db/migrate/20220413180915_add_generated_metadata_to_bulkrax_exporters.rb

@@ -1,4 +1,4 @@
-class AddGeneratedMetadataToBulkraxExporters < ActiveRecord::Migration[5.2]
+class AddGeneratedMetadataToBulkraxExporters < ActiveRecord::Migration[5.1]
   def change
     add_column :bulkrax_exporters, :generated_metadata, :boolean, default: false unless column_exists?(:bulkrax_exporters, :generated_metadata)
   end

data/db/migrate/20220609001128_rename_bulkrax_importer_run_to_importer_run.rb

@@ -1,4 +1,4 @@
-class RenameBulkraxImporterRunToImporterRun < ActiveRecord::Migration[5.2]
+class RenameBulkraxImporterRunToImporterRun < ActiveRecord::Migration[5.1]
   def up
     if column_exists?(:bulkrax_pending_relationships, :bulkrax_importer_run_id)
       remove_foreign_key :bulkrax_pending_relationships, :bulkrax_importer_runs

data/lib/bulkrax/version.rb

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

data/lib/bulkrax.rb

@@ -1,25 +1,34 @@
 # frozen_string_literal: true
 
+require "bulkrax/version"
 require "bulkrax/engine"
 require 'active_support/all'
 
+# rubocop:disable Metrics/ModuleLength
 module Bulkrax
   class << self
-    mattr_accessor :parsers,
-                   :default_work_type,
+    # @todo Move from module attribute methods to a configuration class.  With module attributes,
+    #       when we make a change we are polluting the global space.  This means that our tests that
+    #       modify these config values are modifying global state.  Which is not desirous, as it can
+    #       introduce unexpected flakey tests.
+    mattr_accessor :api_definition,
                    :default_field_mapping,
+                   :default_work_type,
+                   :export_path,
+                   :field_mappings,
                    :fill_in_blank_source_identifiers,
                    :generated_metadata_mapping,
+                   :import_path,
+                   :multi_value_element_join_on,
+                   :multi_value_element_split_on,
+                   :object_factory,
+                   :parsers,
+                   :qa_controlled_properties,
                    :related_children_field_mapping,
                    :related_parents_field_mapping,
-                   :reserved_properties,
-                   :qa_controlled_properties,
-                   :field_mappings,
-                   :import_path,
-                   :export_path,
                    :removed_image_path,
-                   :server_name,
-                   :api_definition
+                   :reserved_properties,
+                   :server_name
 
     self.parsers = [
       { name: "OAI - Dublin Core", class_name: "Bulkrax::OaiDcParser", partial: "oai_fields" },
@@ -29,8 +38,8 @@ module Bulkrax
       { name: "XML", class_name: "Bulkrax::XmlParser", partial: "xml_fields" }
     ]
 
-    self.import_path = 'tmp/imports'
-    self.export_path = 'tmp/exports'
+    self.import_path = Bulkrax.import_path || 'tmp/imports'
+    self.export_path = Bulkrax.export_path || 'tmp/exports'
     self.removed_image_path = Bulkrax::Engine.root.join('spec', 'fixtures', 'removed.png').to_s
     self.server_name = 'bulkrax@example.com'
 
@@ -137,8 +146,73 @@ module Bulkrax
     )
   end
 
+  DEFAULT_MULTI_VALUE_ELEMENT_JOIN_ON = ' | '
+  # Specify the delimiter for joining an attribute's multi-value array into a string.
+  #
+  # @note the specific delimeter should likely be present in the multi_value_element_split_on
+  #       expression.
+  def self.multi_value_element_join_on
+    @multi_value_element_join_on ||= DEFAULT_MULTI_VALUE_ELEMENT_JOIN_ON
+  end
+
+  DEFAULT_MULTI_VALUE_ELEMENT_SPLIT_ON = /\s*[:;|]\s*/.freeze
+  # @return [RegexClass] the regular express to use to "split" an attribute's values.  If set to
+  # `true` use the DEFAULT_MULTI_VALUE_ELEMENT_JOIN_ON.
+  #
+  # @note The "true" value is to preserve backwards compatibility.
+  # @see DEFAULT_MULTI_VALUE_ELEMENT_JOIN_ON
+  def self.multi_value_element_split_on
+    if @multi_value_element_join_on.is_a?(TrueClass)
+      DEFAULT_MULTI_VALUE_ELEMENT_SPLIT_ON
+    else
+      @multi_value_element_split_on ||= DEFAULT_MULTI_VALUE_ELEMENT_SPLIT_ON
+    end
+  end
+
   # this function maps the vars from your app into your engine
   def self.setup
     yield self
   end
+
+  # Responsible for stripping hidden characters from the given string.
+  #
+  # @param value [#to_s]
+  # @return [String] with hidden characters removed
+  #
+  # @see https://github.com/samvera-labs/bulkrax/issues/688
+  def self.normalize_string(value)
+    # Removing [Byte Order Mark (BOM)](https://en.wikipedia.org/wiki/Byte_order_mark)
+    value.to_s.delete("\xEF\xBB\xBF")
+  end
+
+  # This class confirms to the Active::Support.serialze interface.  It's job is to ensure that we
+  # don't have keys with the tricksy Byte Order Mark character.
+  #
+  # @see https://api.rubyonrails.org/classes/ActiveRecord/AttributeMethods/Serialization/ClassMethods.html#method-i-serialize
+  class NormalizedJson
+    def self.normalize_keys(hash)
+      return hash unless hash.respond_to?(:each_pair)
+      returning_value = {}
+      hash.each_pair do |key, value|
+        returning_value[Bulkrax.normalize_string(key)] = value
+      end
+      returning_value
+    end
+
+    # When we write the serialized data to the database, we "dump" the value into that database
+    # column.
+    def self.dump(value)
+      JSON.dump(normalize_keys(value))
+    end
+
+    # When we load the serialized data from the database, we pass the database's value into "load"
+    # function.
+    #
+    # rubocop:disable Security/JSONLoad
+    def self.load(string)
+      normalize_keys(JSON.load(string))
+    end
+    # rubocop:enable Security/JSONLoad
+  end
 end
+# rubocop:disable Metrics/ModuleLength

data/lib/generators/bulkrax/install_generator.rb

@@ -55,6 +55,26 @@ class Bulkrax::InstallGenerator < Rails::Generators::Base
     end
   end
 
+  def add_ability
+    file = 'app/models/ability.rb'
+    file_text = File.read(file)
+    import_line = 'def can_import_works?'
+    export_line = 'def can_export_works?'
+    unless file_text.include?(import_line)
+      insert_into_file file, before: /^end/ do
+        "  def can_import_works?\n    can_create_any_work?\n  end"
+      end
+    end
+
+    # rubocop:disable Style/GuardClause
+    unless file_text.include?(export_line)
+      insert_into_file file, before: /^end/ do
+        "  def can_export_works?\n    can_create_any_work?\n  end"
+      end
+    end
+    # rubocop:enable Style/GuardClause
+  end
+
   def add_css
     ['css', 'scss', 'sass'].map do |ext|
       file = "app/assets/stylesheets/application.#{ext}"

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

@@ -10,6 +10,9 @@ Bulkrax.setup do |config|
   # Default is the first returned by Hyrax.config.curation_concerns
   # config.default_work_type = MyWork
 
+  # Factory Class to use when generating and saving objects
+  config.object_factory = Bulkrax::ObjectFactory
+
   # Path to store pending imports
   # config.import_path = 'tmp/imports'
 
@@ -67,7 +70,16 @@ Bulkrax.setup do |config|
   # is controlled by the active terms in config/authorities/rights_statements.yml
   # Defaults: 'rights_statement' and 'license'
   # config.qa_controlled_properties += ['my_field']
+
+  # Specify the delimiter regular expression for splitting an attribute's values into a multi-value array.
+  # config.multi_value_element_split_on = //\s*[:;|]\s*/.freeze
+
+  # Specify the delimiter for joining an attribute's multi-value array into a string.  Note: the
+  # specific delimeter should likely be present in the multi_value_element_split_on expression.
+  # config.multi_value_element_join_on = ' | '
 end
 
 # Sidebar for hyrax 3+ support
-Hyrax::DashboardController.sidebar_partials[:repository_content] << "hyrax/dashboard/sidebar/bulkrax_sidebar_additions" if Object.const_defined?(:Hyrax) && ::Hyrax::DashboardController&.respond_to?(:sidebar_partials)
+if Object.const_defined?(:Hyrax) && ::Hyrax::DashboardController&.respond_to?(:sidebar_partials)
+  Hyrax::DashboardController.sidebar_partials[:repository_content] << "hyrax/dashboard/sidebar/bulkrax_sidebar_additions"
+end

data/lib/tasks/reset.rake

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+namespace :hyrax do
+  namespace :reset do
+    desc "Delete Bulkrax importers in addition to the reset below"
+    task importers_et_all: :works_and_collections do
+      # sometimes re-running an existing importer causes issues
+      # and you may need to create new ones or delete the existing ones
+      Bulkrax::Importer.delete_all
+    end
+
+    desc 'Reset fedora / solr and corresponding database tables w/o clearing other active record tables like users'
+    task works_and_collections: [:environment] do
+      confirm('You are about to delete all works and collections, this is not reversable!')
+      require 'active_fedora/cleaner'
+      ActiveFedora::Cleaner.clean!
+      Hyrax::PermissionTemplateAccess.delete_all
+      Hyrax::PermissionTemplate.delete_all
+      Bulkrax::PendingRelationship.delete_all
+      Bulkrax::Entry.delete_all
+      Bulkrax::ImporterRun.delete_all
+      Bulkrax::Status.delete_all
+      # Remove sipity methods, everything but sipity roles
+      Sipity::Workflow.delete_all
+      Sipity::EntitySpecificResponsibility.delete_all
+      Sipity::Comment.delete_all
+      Sipity::Entity.delete_all
+      Sipity::WorkflowRole.delete_all
+      Sipity::WorkflowResponsibility.delete_all
+      Sipity::Agent.delete_all
+      Mailboxer::Receipt.destroy_all
+      Mailboxer::Notification.delete_all
+      Mailboxer::Conversation::OptOut.delete_all
+      Mailboxer::Conversation.delete_all
+      AccountElevator.switch!('single.tenant.default')
+      # we need to wait till Fedora is done with its cleanup
+      # otherwise creating the admin set will fail
+      while AdminSet.exists?(AdminSet::DEFAULT_ID)
+        puts 'waiting for delete to finish before reinitializing Fedora'
+        sleep 20
+      end
+
+      Hyrax::CollectionType.find_or_create_default_collection_type
+      Hyrax::CollectionType.find_or_create_admin_set_type
+      AdminSet.find_or_create_default_admin_set_id
+
+      collection_types = Hyrax::CollectionType.all
+      collection_types.each do |c|
+        next unless c.title.match?(/^translation missing/)
+        oldtitle = c.title
+        c.title = I18n.t(c.title.gsub("translation missing: en.", ''))
+        c.save
+        puts "#{oldtitle} changed to #{c.title}"
+      end
+    end
+
+    def confirm(action)
+      return if ENV['RESET_CONFIRMED'].present?
+      confirm_token = rand(36**6).to_s(36)
+      STDOUT.puts "#{action} Enter '#{confirm_token}' to confirm:"
+      input = STDIN.gets.chomp
+      raise "Aborting. You entered #{input}" unless input == confirm_token
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulkrax
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Rob Kaufman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-05 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.2.4
 - !ruby/object:Gem::Dependency
   name: loofah
   requirement: !ruby/object:Gem::Requirement
@@ -328,6 +328,7 @@ files:
 - app/parsers/bulkrax/oai_dc_parser.rb
 - app/parsers/bulkrax/oai_qualified_dc_parser.rb
 - app/parsers/bulkrax/xml_parser.rb
+- app/services/bulkrax/remove_relationships_for_importer.rb
 - app/views/bulkrax/entries/_parsed_metadata.html.erb
 - app/views/bulkrax/entries/_raw_metadata.html.erb
 - app/views/bulkrax/entries/show.html.erb
@@ -404,6 +405,7 @@ files:
 - lib/generators/bulkrax/templates/config/bulkrax_api.yml
 - lib/generators/bulkrax/templates/config/initializers/bulkrax.rb
 - lib/tasks/bulkrax_tasks.rake
+- lib/tasks/reset.rake
 homepage: https://github.com/samvera-labs/bulkrax
 licenses:
 - Apache-2.0