bulkrax 9.0.2 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab6b7a8920333f225336a80591a32f401aef2cfbe466d961c6f1f7a731757625
-  data.tar.gz: 6aa05fc7028e0f1a7f8eb40b2de8b23ba5108a254d0623bb9307a6dff2daf579
+  metadata.gz: fb04fb1689c90c0cb7b96d0fbab95f371e4e4718509638812e62b0bffa1cc9e0
+  data.tar.gz: b3df0b413a151f7c49c6a39e07a705ec0e8c87d181a66de2a0ae75d567297f08
 SHA512:
-  metadata.gz: 33fb1b5b369b6efcc535b80887c74e919e8b8b431b2199dbef35093319f58017d1bd34498d0c1c6df8c86f94eae4f117af2b88c2753eb0065db7630e8f480128
-  data.tar.gz: 214580d620b0c40edd3351ed315d041c86036a1453233a045b35b21991316aa9f1a397032d07d7d6a56a659aa871515c2e64535f238e02d8b591355c1b8f9760
+  metadata.gz: 89a766b0116729946c1ffba1252362fff3f29fd57ab774aebab39fa5b6f2b207a511de3da801b47bce7352a8ef2ca2e3811f306ca0f701ef592acd2a66103f34
+  data.tar.gz: b559f0441c55c23a64568d95d1bcb533dc5b11cf12c9ad8aaed3ab852a0f9ea88b1e9140968b6272af54d05d2edae3ff3dadb5433e07fa6c55d90e615f42447d

data/README.md

@@ -208,6 +208,32 @@ We encourage everyone to help improve this project.  Bug reports and pull reques
 
 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.
 
+### Running tests
+- The tests use sqlite as the database, so no extra dependencies are required. 
+- Ensure you are using a supported version of Ruby (`ruby -v` should be greater or equal to 2.7) 
+- If you are using a ruby version earlier than 3.0.0, install bundler explicitly (newer versions of ruby will automatically install an appropriate bundler version)
+```bash
+/path/to/ruby/install/bin/gem install bundler -v '~> 2.4.0'
+```
+- Decide on your version of Hyrax to test against and export it to your environment, then bundle install. The Hyrax version should be greater or equal to 2.3.
+```bash
+export HYRAX_VERSION="~> 4.0.0"
+bundle install
+```
+- Run the test migrations
+```bash
+bundle exec bin/rails db:migrate RAILS_ENV=test
+```
+- Run the tests
+```bash
+bundle exec rspec
+```
+
+- Run the style checker / linter
+```bash
+bundle exec rubocop
+```
+
 ## Questions
 Questions can be sent to support@notch8.com. Please make sure to include "Bulkrax" in the subject line of your email.
 

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

@@ -3,6 +3,10 @@ Blacklight.onLoad(function() {
     $('#importer-show-table').DataTable( {
       'processing': true,
       'serverSide': true,
+      'width': '100%',
+      'autoWidth': false,
+      'scrollX': true,
+      'scrollCollapse': true,
       "ajax": window.location.href.replace(/(\/(importers|exporters)\/\d+)/, "$1/entry_table.json"),
       "pageLength": 30,
       "lengthMenu": [[30, 100, 200], [30, 100, 200]],
@@ -15,6 +19,14 @@ Blacklight.onLoad(function() {
         { "data": "errors", "orderable": false },
         { "data": "actions", "orderable": false }
       ],
+      drawCallback: function() {
+        // Remove the inline styles that DataTables adds to the scrollHeadInner and table elements
+        // it's not perfect but better than the style being applied
+        setTimeout(function() {
+          $('.dataTables_scrollHeadInner').removeAttr('style');
+          $('.table.table-striped.dataTable.no-footer').removeAttr('style');
+        }, 100);
+      },
       initComplete: function () {
         // Add entry class filter
         entrySelect.bind(this)()

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

@@ -15,7 +15,10 @@ function prepBulkrax(event) {
   // Initialize the uploader only if hyraxUploader is defined
   if (typeof $.fn.hyraxUploader === 'function') {
     // Initialize the uploader
-    $('.fileupload-bulkrax').hyraxUploader({ maxNumberOfFiles: 1 });
+    $('.fileupload-bulkrax').hyraxUploader({ 
+      maxNumberOfFiles: 1,
+      maxFileSize: <%= (defined?(Hyrax) && Hyrax.config.uploader[:maxFileSize]) || 524288000 %>
+    });
 
     // Function to toggle 'required' attribute based on uploaded files
     function toggleRequiredAttribute() {

data/app/factories/bulkrax/object_factory.rb

@@ -28,6 +28,40 @@ module Bulkrax
       resource.file_sets.each(&:update_index) if resource.respond_to?(:file_sets)
     end
 
+    ##
+    # @return [String] the name of the model class for the given resource/object.
+    def self.model_name(resource:)
+      resource.has_model.first
+    end
+
+    ##
+    # A thumbnail is linked to a work rather than the file set itself.
+    # @return [File or FileMetadata] the thumbnail file for the given resource
+    def self.thumbnail_for(resource:)
+      return nil unless resource.respond_to?(:thumbnail)
+      return resource.thumbnail if resource.thumbnail.present?
+      return nil unless resource.respond_to?(:parent) && resource.parent.present?
+      return nil unless resource.parent.respond_to?(:thumbnail)
+      resource.parent.thumbnail
+    end
+
+    ##
+    # @input [Fileset]
+    # @return [File] the original file.
+    def self.original_file(fileset:)
+      fileset.try(:original_file)
+    end
+
+    ##
+    # #input [Fileset or FileMetadata]
+    # @return [String] the file name for the given fileset
+    def self.filename_for(fileset:)
+      file = original_file(fileset: fileset)
+      file.file_name.first
+    rescue NoMethodError
+      nil
+    end
+
     ##
     # @see Bulkrax::ObjectFactoryInterface
     def self.export_properties
@@ -91,7 +125,7 @@ module Bulkrax
     # @note HEY WE'RE USING THIS FOR A WINGS CUSTOM QUERY.  BE CAREFUL WITH
     #       REMOVING IT.
     #
-    # @see # {Wings::CustomQueries::FindBySourceIdentifier#find_by_model_and_property_value}
+    # @see # {Wings::CustomQueries::FindBySourceIdentifier#find_by_property_value}
     def self.search_by_property(value:, klass:, field: nil, search_field: nil, name_field: nil, verify_property: false)
       return nil unless klass.respond_to?(:where)
       # We're not going to try to match nil nor "".
@@ -166,7 +200,7 @@ module Bulkrax
 
     def delete(_user)
       obj = find
-      return false unless obj
+      raise ObjectFactoryInterface::ObjectNotFoundError, "Object not found to delete" unless obj
 
       obj.delete(eradicate: true)
     end

data/app/factories/bulkrax/object_factory_interface.rb

@@ -209,6 +209,32 @@ module Bulkrax
     end
     # rubocop:enable Metrics/ParameterLists
 
+    ##
+    # @return [String] the name of the model class for the given resource/object.
+    def self.model_name(resource:)
+      raise NotImplementedError, "#{self}.#{__method__}"
+    end
+
+    ##
+    # @return [File or FileMetadata] the thumbnail file for the given resource
+    def self.thumbnail_for(resource:)
+      raise NotImplementedError, "#{self}.#{__method__}"
+    end
+
+    ##
+    # @input [Fileset or FileMetadata]
+    # @return [File or FileMetadata] the original file
+    def self.original_file(fileset:)
+      raise NotImplementedError, "#{self}.#{__method__}"
+    end
+
+    ##
+    # #input [Fileset or FileMetadata]
+    # @return [String] the file name for the given fileset
+    def self.filename_for(fileset:)
+      raise NotImplementedError, "#{self}.#{__method__}"
+    end
+
     ##
     # @api private
     #

data/app/factories/bulkrax/valkyrie_object_factory.rb

@@ -38,12 +38,54 @@ module Bulkrax
       end
     end
 
+    # Customized create method for Valkyrie so that @object gets set
+    def create
+      attrs = transform_attributes
+      @object = klass.new
+      conditionally_set_reindex_extent
+      run_callbacks :save do
+        run_callbacks :create do
+          @object = if klass == Bulkrax.collection_model_class
+                      create_collection(attrs)
+                    elsif klass == Bulkrax.file_model_class
+                      create_file_set(attrs)
+                    else
+                      create_work(attrs)
+                    end
+        end
+      end
+
+      apply_depositor_metadata
+      log_created(@object)
+    end
+
+    # Customized update method for Valkyrie so that @object gets set
+    def update
+      raise "Object doesn't exist" unless object
+      conditionally_destroy_existing_files
+
+      attrs = transform_attributes(update: true)
+      run_callbacks :save do
+        @object = if klass == Bulkrax.collection_model_class
+                    update_collection(attrs)
+                  elsif klass == Bulkrax.file_model_class
+                    update_file_set(attrs)
+                  else
+                    update_work(attrs)
+                  end
+      end
+      apply_depositor_metadata
+      log_updated(@object)
+    end
+
     # TODO: the following module needs revisiting for Valkyrie work.
     #       proposal is to create Bulkrax::ValkyrieFileFactory.
     include Bulkrax::FileFactory
 
     self.file_set_factory_inner_workings_class = Bulkrax::ValkyrieObjectFactory::FileFactoryInnerWorkings
 
+    delegate :transactions, to: :class
+
     ##
     # When you want a different set of transactions you can change the
     # container.
@@ -55,24 +97,25 @@ module Bulkrax
       @transactions || Hyrax::Transactions::Container
     end
 
-    def transactions
-      self.class.transactions
-    end
-
     ##
     # @!group Class Method Interface
 
     ##
-    # @note This does not save either object.  We need to do that in another
-    #       loop.  Why?  Because we might be adding many items to the parent.
+    # When adding a child to a parent work, we save the parent.
+    # Locking appears inconsistent, so we are finding the parent and
+    # saving it with each child, but waiting until the end to reindex.
+    # To do this we are bypassing the save! method defined below
     def self.add_child_to_parent_work(parent:, child:)
+      parent = self.find(parent.id)
       return true if parent.member_ids.include?(child.id)
-
       parent.member_ids << child.id
-      parent.save
+      Hyrax.persister.save(resource: parent)
     end
 
+    ##
+    # The resource added to a collection can be either a work or another collection.
     def self.add_resource_to_collection(collection:, resource:, user:)
+      resource = self.find(resource.id)
       resource.member_of_collection_ids << collection.id
       save!(resource: resource, user: user)
     end
@@ -112,7 +155,7 @@ module Bulkrax
       Hyrax.query_service.find_by(id: id)
       # Because Hyrax is not a hard dependency, we need to transform the Hyrax exception into a
       # common exception so that callers can handle a generalize exception.
-    rescue Hyrax::ObjectNotFoundError => e
+    rescue Hyrax::ObjectNotFoundError, Valkyrie::Persistence::ObjectNotFoundError => e
       raise ObjectFactoryInterface::ObjectNotFoundError, e.message
     end
 
@@ -127,6 +170,8 @@ module Bulkrax
     end
 
     def self.publish(event:, **kwargs)
+      # It's a bit unclear what this should be if we can't rely on Hyrax.
+      raise NotImplementedError, "#{self}.#{__method__}" unless defined?(Hyrax)
       Hyrax.publisher.publish(event, **kwargs)
     end
 
@@ -139,19 +184,19 @@ module Bulkrax
     end
 
     def self.save!(resource:, user:)
-      if resource.respond_to?(:save!)
-        resource.save!
-      else
+      if defined?(Hyrax)
         result = Hyrax.persister.save(resource: resource)
         raise Valkyrie::Persistence::ObjectNotFoundError unless result
         Hyrax.index_adapter.save(resource: result)
         if result.collection?
-          publish('collection.metadata.updated', collection: result, user: user)
+          self.publish(event: 'collection.metadata.updated', collection: result, user: user)
         else
-          publish('object.metadata.updated', object: result, user: user)
+          self.publish(event: 'object.metadata.updated', object: result, user: user)
         end
-        resource
+      else
+        resource.save!
       end
+      resource
     end
 
     def self.update_index(resources:)
@@ -165,6 +210,46 @@ module Bulkrax
       update_index(resources: file_sets)
     end
 
+    ##
+    # If we always want the valkyrized resource name, even for unmigrated objects, we can
+    # simply use resource.model_name.name. At this point, we are differentiating
+    # to help identify items which have been migrated to Valkyrie vs those which have not.
+    #
+    # @return [String] the name of the model class for the given resource/object.
+    def self.model_name(resource:)
+      resource.class.to_s
+    end
+
+    ##
+    # @return [File or FileMetadata] the thumbnail file for the given resource
+    def self.thumbnail_for(resource:)
+      # recursive call to parent if resource is a fileset - we want the work's thumbnail
+      return thumbnail_for(resource: resource&.parent) if resource.is_a?(Bulkrax.file_model_class)
+
+      return nil unless resource.respond_to?(:thumbnail_id) && resource.thumbnail_id.present?
+      Bulkrax.object_factory.find(resource.thumbnail_id.to_s)
+    rescue Bulkrax::ObjectFactoryInterface::ObjectNotFoundError
+      nil
+    end
+
+    ##
+    # @input [Fileset or FileMetadata]
+    # @return [FileMetadata] the original file
+    def self.original_file(fileset:)
+      fileset.try(:original_file) || fileset
+    end
+
+    ##
+    # #input [Fileset or FileMetadata]
+    # @return [String] the file name for the given fileset
+    def self.filename_for(fileset:)
+      file = original_file(fileset: fileset)
+      return nil unless file
+      file.original_filename
+    rescue NoMethodError
+      nil
+    end
+
     ##
     # @param value [String]
     # @param klass [Class, #where]
@@ -176,13 +261,12 @@ module Bulkrax
     # @return [Valkyrie::Resource] when a match is found, an instance of given
     #         :klass
     # rubocop:disable Metrics/ParameterLists
-    def self.search_by_property(value:, klass:, field: nil, name_field: nil, **)
+    def self.search_by_property(value:, field: nil, name_field: nil, search_field:, **)
       name_field ||= field
       raise "Expected named_field or field got nil" if name_field.blank?
       return if value.blank?
-
       # Return nil or a single object.
-      Hyrax.query_service.custom_query.find_by_model_and_property_value(model: klass, property: name_field, value: value)
+      Hyrax.query_service.custom_queries.find_by_property_value(property: name_field, value: value, search_field: search_field)
     end
     # rubocop:enable Metrics/ParameterLists
 
@@ -208,11 +292,11 @@ module Bulkrax
 
     def delete(user)
       obj = find
-      return false unless obj
+      raise ObjectFactoryInterface::ObjectNotFoundError, "Object not found to delete" unless obj
 
       Hyrax.persister.delete(resource: obj)
       Hyrax.index_adapter.delete(resource: obj)
-      self.class.publish(event: 'object.deleted', object: obj, user: user)
+      Hyrax.publisher.publish('object.deleted', object: obj, user: user)
     end
 
     def run!
@@ -231,7 +315,7 @@ module Bulkrax
 
       @object.depositor = @user.email
       object = Hyrax.persister.save(resource: @object)
-      self.class.publish(event: "object.metadata.updated", object: object, user: @user)
+      Hyrax.publisher.publish("object.metadata.updated", object: object, user: @user)
       object
     end
 
@@ -248,6 +332,7 @@ module Bulkrax
 
     def create_file_set(attrs)
       # TODO: Make it work for Valkyrie
+      raise NotImplementedError, __method__.to_s
     end
 
     def create_work(attrs)
@@ -337,7 +422,7 @@ module Bulkrax
     end
 
     def find_by_id
-      Hyrax.query_service.find_by(id: attributes[:id]) if attributes.key? :id
+      self.class.find(attributes[:id]) if attributes.key? :id
     end
 
     ##
@@ -433,7 +518,6 @@ module Bulkrax
       remote_files.map do |r|
         file_path = download_file(r["url"])
         next unless file_path
-
         create_uploaded_file(file_path, r["file_name"])
       end.compact
     end
@@ -449,8 +533,7 @@ module Bulkrax
         file.rewind
         file.path
       rescue => e
-        Rails.logger.debug "Failed to download file from #{url}: #{e.message}"
-        nil
+        raise "Failed to download file from #{url}: #{e.message}"
       end
     end
 
@@ -460,8 +543,7 @@ module Bulkrax
       file.close
       uploaded_file
     rescue => e
-      Rails.logger.debug "Failed to create Hyrax::UploadedFile for #{file_name}: #{e.message}"
-      nil
+      raise "Failed to create Hyrax::UploadedFile for #{file_name}: #{e.message}"
     end
 
     # @Override Destroy existing files with Hyrax::Transactions