hyrax 3.4.1 → 4.0.0.beta1

data/lib/hyrax/specs/capybara.rb

@@ -17,6 +17,8 @@ require 'capybara-screenshot/rspec'
 require 'selenium-webdriver'
 require 'webdrivers' unless ENV['IN_DOCKER'].present? || ENV['HUB_URL'].present?
 
+Capybara.save_path = ENV['CI'] ? "/tmp/test-results" : Rails.root.join('tmp', 'capybara')
+
 if ENV['IN_DOCKER'].present? || ENV['HUB_URL'].present?
   args = %w[disable-gpu no-sandbox whitelisted-ips window-size=1400,1400]
   args.push('headless') if ActiveModel::Type::Boolean.new.cast(ENV['CHROME_HEADLESS_MODE'])
@@ -67,8 +69,8 @@ Capybara::Screenshot.register_driver(:selenium_chrome_headless_sandboxless) do |
   driver.browser.save_screenshot(path)
 end
 
-Capybara::Screenshot.autosave_on_failure = false
-Capybara::Screenshot.prune_strategy = { keep: 10 }
+Capybara::Screenshot.autosave_on_failure = true
+Capybara::Screenshot.prune_strategy = :keep_last_run
 
 # Save CircleCI artifacts
 
@@ -79,7 +81,7 @@ def save_timestamped_page_and_screenshot(page, meta)
   time_now = Time.zone.now
   timestamp = "#{time_now.strftime('%Y-%m-%d-%H-%M-%S.')}#{'%03d' % (time_now.usec / 1000).to_i}"
 
-  artifact_dir = ENV['CI'] ? "/tmp/test-results" : Rails.root.join('tmp', 'capybara')
+  artifact_dir = Capybara.save_path
 
   screenshot_name = "screenshot-#{filename}-#{line_number}-#{timestamp}.png"
   screenshot_path = "#{artifact_dir}/#{screenshot_name}"

data/lib/hyrax/specs/shared_specs/hydra_works.rb

@@ -135,7 +135,6 @@ RSpec.shared_examples 'a Hyrax::PcdmCollection' do
 
   it_behaves_like 'a Hyrax::Resource'
   it_behaves_like 'a model with core metadata'
-  it_behaves_like 'a model with basic metadata'
   it_behaves_like 'has members'
 
   describe '#collection_type_gid' do

data/lib/hyrax/transactions/collection_update.rb

@@ -9,6 +9,8 @@ module Hyrax
     # @since 3.2.0
     class CollectionUpdate < Transaction
       DEFAULT_STEPS = ['change_set.apply',
+                       'collection_resource.save_collection_banner',
+                       'collection_resource.save_collection_logo',
                        'collection_resource.save_acl'].freeze
 
       ##

data/lib/hyrax/transactions/container.rb

@@ -42,6 +42,8 @@ module Hyrax
       require 'hyrax/transactions/steps/remove_file_set_from_work'
       require 'hyrax/transactions/steps/save'
       require 'hyrax/transactions/steps/save_access_control'
+      require 'hyrax/transactions/steps/save_collection_banner'
+      require 'hyrax/transactions/steps/save_collection_logo'
       require 'hyrax/transactions/steps/set_default_admin_set'
       require 'hyrax/transactions/steps/set_modified_date'
       require 'hyrax/transactions/steps/set_uploaded_date_unless_present'
@@ -50,17 +52,6 @@ module Hyrax
       require 'hyrax/transactions/steps/update_work_members'
       require 'hyrax/transactions/steps/validate'
 
-      # The following transactions and steps are deprecated.
-      require 'hyrax/transactions/create_work'
-      require 'hyrax/transactions/destroy_work'
-      require 'hyrax/transactions/update_work'
-      require 'hyrax/transactions/steps/apply_collection_permission_template'
-      require 'hyrax/transactions/steps/apply_permission_template'
-      require 'hyrax/transactions/steps/apply_visibility'
-      require 'hyrax/transactions/steps/destroy_work'
-      require 'hyrax/transactions/steps/ensure_permission_template'
-      require 'hyrax/transactions/steps/save_work'
-
       extend Dry::Container::Mixin
 
       # Disable BlockLength rule for DSL code
@@ -195,6 +186,14 @@ module Hyrax
         ops.register 'save_acl' do
           Steps::SaveAccessControl.new
         end
+
+        ops.register 'save_collection_banner' do
+          Steps::SaveCollectionBanner.new
+        end
+
+        ops.register 'save_collection_logo' do
+          Steps::SaveCollectionLogo.new
+        end
       end
 
       namespace 'work_resource' do |ops| # Hyrax::Work resource
@@ -230,49 +229,6 @@ module Hyrax
           Steps::UpdateWorkMembers.new
         end
       end
-
-      # legacy AF works processing by transactions is deprecated
-      namespace 'work' do |ops|
-        ops.register 'apply_collection_permission_template' do
-          Steps::ApplyCollectionPermissionTemplate.new
-        end
-
-        ops.register 'apply_permission_template' do
-          Steps::ApplyPermissionTemplate.new
-        end
-
-        ops.register 'apply_visibility' do
-          Steps::ApplyVisibility.new
-        end
-
-        ops.register 'destroy_work' do
-          Steps::DestroyWork.new
-        end
-
-        ops.register 'ensure_admin_set' do
-          Steps::EnsureAdminSet.new
-        end
-
-        ops.register 'ensure_permission_template' do
-          Steps::EnsurePermissionTemplate.new
-        end
-
-        ops.register 'save_work' do
-          Steps::SaveWork.new
-        end
-
-        ops.register 'set_default_admin_set' do
-          Steps::SetDefaultAdminSet.new
-        end
-
-        ops.register 'set_modified_date' do
-          Steps::SetModifiedDate.new
-        end
-
-        ops.register 'set_uploaded_date_unless_present' do
-          Steps::SetUploadedDateUnlessPresent.new
-        end
-      end
       # rubocop:enable Metrics/BlockLength
     end
   end

data/lib/hyrax/transactions/steps/save_collection_banner.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Adds banner info via `ChangeSet`.
+      #
+      # During the update collection process this step is called to update the file
+      # to be used as a the banner for the collection.
+      #
+      class SaveCollectionBanner
+        include Dry::Transaction::Operation
+
+        ##
+        # @param [Hyrax::ChangeSet] change_set
+        # @param [Array<Integer>] update_banner_file_ids
+        # @param [Boolean] banner_unchanged_indicator
+        #
+        # @return [Dry::Monads::Result] `Failure` if the banner info fails to save;
+        #   `Success(input)`, otherwise.
+        def call(collection_resource, update_banner_file_ids: nil, banner_unchanged_indicator: true)
+          return Success(collection_resource) if ActiveModel::Type::Boolean.new.cast(banner_unchanged_indicator)
+          collection_id = collection_resource.id.to_s
+          process_banner_input(collection_id: collection_id, update_banner_file_ids: update_banner_file_ids)
+          Success(collection_resource)
+        end
+
+        private
+
+        def process_banner_input(collection_id:, update_banner_file_ids:)
+          remove_banner(collection_id: collection_id)
+          add_new_banner(collection_id: collection_id, uploaded_file_ids: update_banner_file_ids) if update_banner_file_ids
+        end
+
+        def remove_banner(collection_id:)
+          banner_info = CollectionBrandingInfo.where(collection_id: collection_id).where(role: "banner")
+          banner_info&.delete_all
+        end
+
+        def add_new_banner(collection_id:, uploaded_file_ids:)
+          f = uploaded_files(uploaded_file_ids).first
+          banner_info = CollectionBrandingInfo.new(
+            collection_id: collection_id,
+            filename: File.split(f.file_url).last,
+            role: "banner",
+            alt_txt: "",
+            target_url: ""
+          )
+          banner_info.save f.file_url
+        end
+
+        def uploaded_files(uploaded_file_ids)
+          return [] if uploaded_file_ids.empty?
+          UploadedFile.find(uploaded_file_ids)
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/steps/save_collection_logo.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # Adds logo info via `ChangeSet`.
+      #
+      # During the update collection process this step is called to update the file(s)
+      # to be used as logo(s) for the collection.
+      #
+      class SaveCollectionLogo
+        include Dry::Transaction::Operation
+
+        ##
+        # @param [Hyrax::ChangeSet] change_set
+        # @param [Array<#Integer>] update_logo_file_ids
+        # @param [Array<String>] alttext_values
+        # @param [Array<String>] linkurl_values
+        #
+        # @return [Dry::Monads::Result] `Failure` if the work fails to save;
+        #   `Success(input)`, otherwise.
+        def call(collection_resource, update_logo_file_ids: nil, alttext_values: nil, linkurl_values: nil)
+          collection_id = collection_resource.id.to_s
+          process_logo_input(collection_id: collection_id, update_logo_file_ids: update_logo_file_ids, alttext_values: alttext_values, linkurl_values: linkurl_values)
+          Success(collection_resource)
+        end
+
+        private
+
+        def process_logo_input(collection_id:, update_logo_file_ids:, alttext_values:, linkurl_values:)
+          uploaded_file_ids = update_logo_file_ids
+          public_files = []
+
+          if uploaded_file_ids.nil?
+            # all logo files were removed, so delete all files previously uploaded
+            remove_redundant_files(collection_id: collection_id, public_files: public_files)
+            return
+          end
+
+          public_files = process_logo_records(collection_id: collection_id, uploaded_file_ids: uploaded_file_ids, alttext_values: alttext_values, linkurl_values: linkurl_values)
+          remove_redundant_files(collection_id: collection_id, public_files: public_files)
+        end
+
+        def process_logo_records(collection_id:, uploaded_file_ids:, alttext_values:, linkurl_values:)
+          public_files = []
+          uploaded_file_ids.each_with_index do |ufi, i|
+            # If the user has chosen a new logo, the ufi will be an integer
+            # If the logo was previously chosen, the ufi will be a path
+            # If it is a path, update the rec, else create a new rec
+            if !ufi.match(/\D/).nil?
+              update_logo_info(collection_id: collection_id, uploaded_file_id: ufi, alttext: alttext_values[i], linkurl: verify_linkurl(linkurl_values[i]))
+              public_files << ufi
+            else # brand new one, insert in the database
+              logo_info = create_logo_info(collection_id: collection_id, uploaded_file_id: ufi, alttext: alttext_values[i], linkurl: verify_linkurl(linkurl_values[i]))
+              public_files << logo_info.local_path
+            end
+          end
+          public_files
+        end
+
+        def update_logo_info(collection_id:, uploaded_file_id:, alttext:, linkurl:)
+          logo_info = CollectionBrandingInfo.where(collection_id: collection_id).where(role: "logo").where(local_path: uploaded_file_id.to_s).first
+          logo_info.alt_text = alttext
+          logo_info.target_url = linkurl
+          logo_info.local_path = uploaded_file_id
+          logo_info.save(uploaded_file_id, false)
+        end
+
+        def create_logo_info(collection_id:, uploaded_file_id:, alttext:, linkurl:)
+          file = uploaded_files(uploaded_file_id)
+          logo_info = CollectionBrandingInfo.new(
+            collection_id: collection_id,
+            filename: File.split(file.file_url).last,
+            role: "logo",
+            alt_txt: alttext,
+            target_url: linkurl
+          )
+          logo_info.save file.file_url
+          logo_info
+        end
+
+        def uploaded_files(uploaded_file_ids)
+          return [] if uploaded_file_ids.empty?
+          UploadedFile.find(uploaded_file_ids)
+        end
+
+        def remove_redundant_files(collection_id:, public_files:)
+          # remove any public ones that were not included in the selection.
+          logos_info = CollectionBrandingInfo.where(collection_id: collection_id).where(role: "logo")
+          logos_info.each do |logo_info|
+            logo_info.delete(logo_info.local_path) unless public_files.include? logo_info.local_path
+            logo_info.destroy unless public_files.include? logo_info.local_path
+          end
+        end
+
+        # Only accept HTTP|HTTPS urls;
+        # @return <String> the url
+        def verify_linkurl(linkurl)
+          url = Loofah.scrub_fragment(linkurl, :prune).to_s
+          url if valid_url?(url)
+        end
+
+        def valid_url?(url)
+          (url =~ URI.regexp(['http', 'https']))
+        end
+      end
+    end
+  end
+end

data/lib/hyrax/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Hyrax
-  VERSION = '3.4.1'
+  VERSION = '4.0.0.beta1'
 end

data/lib/valkyrie/indexing/solr/indexing_adapter.rb

@@ -79,7 +79,7 @@ module Valkyrie
                    end
 
           # if any configuration is missing, derive it from Blacklight
-          config = blacklight_based_config.merge(config)
+          config = blacklight_based_config.with_indifferent_access.merge(config)
 
           "http://#{config['host']}:#{config['port']}/solr/#{config['core']}"
         end

data/lib/wings/active_fedora_converter/file_metadata_node.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Wings
+  class ActiveFedoraConverter
+    def self.FileMetadataNode(resource_class) # rubocop:disable Naming/MethodName
+      class_cache[resource_class] ||= Class.new(FileMetadataNode) do
+        self.valkyrie_class = resource_class
+
+        # skip reserved attributes, we assume we don't need to translate valkyrie internals
+        schema = resource_class.schema.reject do |key|
+          resource_class.reserved_attributes.include?(key.name) ||
+            key.name == :size
+        end
+
+        Wings::ActiveFedoraConverter.apply_properties(self, schema)
+      end
+    end
+  end
+
+  class FileMetadataNode < ActiveFedora::Base
+    property :file_set_id, predicate: ::RDF::URI.intern("http://hyrax.samvera.org/ns/wings#file_set_id")
+    property :file_identifier, predicate: ::RDF::URI.intern("http://hyrax.samvera.org/ns/wings#file_identifier")
+
+    class_attribute :valkyrie_class
+
+    class << self
+      def model_name(*)
+        Hyrax::Name.new(valkyrie_class)
+      end
+
+      def to_rdf_representation
+        "Wings(#{valkyrie_class})"
+      end
+      alias inspect to_rdf_representation
+      alias to_s inspect
+    end
+
+    def indexing_service
+      Hyrax::ValkyrieIndexer.for(resource: valkyrie_resource)
+    end
+
+    def to_solr
+      super.tap do |doc|
+        doc[:file_identifier_ssim] = file_identifier
+      end
+    end
+  end
+end

data/lib/wings/active_fedora_converter/instance_builder.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Wings
+  class ActiveFedoraConverter
+    ##
+    # Constructs an instance for the given converter. +converter+ must provide
+    # an +id+, +resource+, and +active_fedora_class+.
+    #
+    # This interface allows handling for special cases based on the target
+    # class, instance data for +resource+, or the id format. This originated as
+    # an extraction of some such special handling from the converter code.
+    class InstanceBuilder
+      ##
+      # @!attribute [r] converter
+      #   @return [#active_fedora_class, #id, #resource]
+      # @!attribute [r] resource
+      #   @return [Valkyrie::Resource]
+      attr_reader :converter, :resource
+
+      ##
+      # @param [#active_fedora_class, #id, #resource]
+      def initialize(converter)
+        @converter = converter
+        @resource = converter.resource
+      end
+
+      ##
+      # @return [ActiveFedora::Common]
+      def build
+        if builds_file_metadata? && !builds_metadata_for_active_fedora_file?
+          # convert to a generic/generated FileMetadataNode class with
+          # properties matching the source class
+          Wings::ActiveFedoraConverter::FileMetadataNode(resource.class)
+                                      .new(file_identifier: Array(resource.file_identifier)
+            .map(&:to_s))
+        elsif converter.id.present?
+          converter.active_fedora_class.find(converter.id)
+        else
+          converter.active_fedora_class.new
+        end
+      rescue ActiveFedora::ObjectNotFoundError
+        converter.active_fedora_class.new
+      end
+
+      ##
+      # @return [Boolean]
+      def builds_file_metadata?
+        resource.try(:file_identifier).present?
+      end
+
+      ##
+      # @return [Boolean]
+      def builds_metadata_for_active_fedora_file?
+        return false unless builds_file_metadata?
+
+        adapter_for_file = begin
+                             ::Valkyrie::StorageAdapter.adapter_for(id: resource.file_identifier)
+                           rescue ::Valkyrie::StorageAdapter::AdapterNotFoundError => err
+                             Hyrax.logger.warn "Processing a FileMetadata (id: #{converter.id}) referencing " \
+                                               "a file #{resource.file_identifier}; could not find a " \
+                                               "storage adapter to handle that file.\n\t#{err.message}"
+                           end
+
+        adapter_for_file.is_a?(::Valkyrie::Storage::Fedora)
+      end
+    end
+  end
+end

data/lib/wings/active_fedora_converter.rb

@@ -2,6 +2,8 @@
 
 require 'wings/converter_value_mapper'
 require 'wings/active_fedora_converter/default_work'
+require 'wings/active_fedora_converter/file_metadata_node'
+require 'wings/active_fedora_converter/instance_builder'
 require 'wings/active_fedora_converter/nested_resource'
 
 module Wings
@@ -100,9 +102,7 @@ module Wings
     private
 
     def instance
-      id.present? ? active_fedora_class.find(id) : active_fedora_class.new
-    rescue ActiveFedora::ObjectNotFoundError
-      active_fedora_class.new
+      InstanceBuilder.new(self).build
     end
 
     def attributes_class

data/lib/wings/services/custom_queries/find_file_metadata.rb

@@ -33,7 +33,20 @@ module Wings
       #
       # @raise [Hyrax::ObjectNotFoundError]
       def find_file_metadata_by(id:, use_valkyrie: true)
-        find_file_metadata_by_alternate_identifier(alternate_identifier: id, use_valkyrie: use_valkyrie)
+        fcrepo_flag =
+          begin
+            ::Valkyrie::StorageAdapter.adapter_for(id: id).is_a?(::Valkyrie::Storage::Fedora)
+          rescue ::Valkyrie::StorageAdapter::AdapterNotFoundError
+            true # assume fcrepo if we can't find an adapter
+          end
+
+        if fcrepo_flag
+          find_file_metadata_by_alternate_identifier(alternate_identifier: id, use_valkyrie: use_valkyrie)
+        else
+          result = ActiveFedora::Base.where(file_identifier_ssim: id.to_s).first ||
+                   raise(Hyrax::ObjectNotFoundError)
+          result.valkyrie_resource
+        end
       end
 
       # Find a Hyrax::FileMetadata using an alternate ID, and map it to a
@@ -48,8 +61,8 @@ module Wings
       #
       # @raise [Hyrax::ObjectNotFoundError]
       def find_file_metadata_by_alternate_identifier(alternate_identifier:, use_valkyrie: true)
-        alternate_identifier = ::Valkyrie::ID.new(alternate_identifier)
-        object = Hydra::PCDM::File.find(alternate_identifier.to_s)
+        alternate_identifier = ::Valkyrie::ID.new(alternate_identifier).to_s
+        object = Hydra::PCDM::File.find(alternate_identifier)
         raise Hyrax::ObjectNotFoundError if object.new_record?
 
         if use_valkyrie == false
@@ -73,11 +86,9 @@ module Wings
       #   if there are no ids or none of the ids map to Hyrax::FileMetadata
       def find_many_file_metadata_by_ids(ids:, use_valkyrie: true)
         ids.each_with_object([]) do |alt_id, results|
-          begin
-            results << find_file_metadata_by_alternate_identifier(alternate_identifier: alt_id, use_valkyrie: use_valkyrie)
-          rescue Hyrax::ObjectNotFoundError
-            next
-          end
+          results << find_file_metadata_by_alternate_identifier(alternate_identifier: alt_id, use_valkyrie: use_valkyrie)
+        rescue Hyrax::ObjectNotFoundError
+          next
         end
       end
 

data/lib/wings/valkyrie/persister.rb

@@ -74,7 +74,8 @@ module Wings
 
         def initialize(msg = nil, obj:)
           self.obj = obj
-          msg = "Failed to save object {obj}.\n" + msg
+
+          msg = "Failed to save object #{obj}.\n" + msg
           super(msg)
         end
       end

data/lib/wings/valkyrie/query_service.rb

@@ -86,12 +86,10 @@ module Wings
         return enum_for(:find_many_by_ids, ids: ids) unless block_given?
 
         ids.map(&:to_s).uniq.each do |id|
-          begin
-            af_object = ActiveFedora::Base.find(id)
-            yield resource_factory.to_resource(object: af_object)
-          rescue ::ActiveFedora::ObjectNotFoundError, Ldp::Gone
-            next
-          end
+          af_object = ActiveFedora::Base.find(id)
+          yield resource_factory.to_resource(object: af_object)
+        rescue ::ActiveFedora::ObjectNotFoundError, Ldp::Gone
+          next
         end
       end
 

data/package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "dotenv": "^16.0.1",
+    "jasmine-core": "^3.99",
+    "karma": "^6.3.20",
+    "karma-chrome-launcher": "^3.1.1",
+    "karma-coffee-preprocessor": "^1.0.1",
+    "karma-jasmine": "^4.0.2",
+    "karma-spec-reporter": "^0.0.34"
+  }
+}

data/tasks/hyrax_dev.rake

@@ -34,6 +34,38 @@ task :i18n_sorter do
   end
 end
 
+Rake::Task["engine_cart:generate"].clear
+
+namespace :engine_cart do
+  desc "Create the test rails app"
+  task generate: [:setup] do
+    if EngineCart.fingerprint_expired?
+
+      # Create a new test rails app
+      Rake::Task['engine_cart:create_test_rails_app'].invoke
+      Rake::Task['engine_cart:inject_gemfile_extras'].invoke
+
+      # Copy our test app generators into the app and prepare it
+      Bundler.clean_system "cp -r #{EngineCart.templates_path}/lib/generators #{EngineCart.destination}/lib" if File.exist? "#{EngineCart.templates_path}/lib/generators"
+
+      within_test_app do
+        unless (system("bundle install --quiet") || system("bundle update --quiet")) &&
+               system("(bundle exec rails g | grep test_app) && bundle exec rails generate test_app") &&
+               system("bundle exec rake db:migrate") &&
+               system("bundle exec rake db:test:prepare")
+          raise "EngineCart failed on with: #{$CHILD_STATUS}"
+        end
+      end
+
+      Bundler.clean_system "bundle install --quiet"
+
+      EngineCart.write_fingerprint
+
+      puts "Done generating test app"
+    end
+  end
+end
+
 if Gem.loaded_specs.key? 'engine_cart'
   namespace :engine_cart do
     # This generate task should only add its action to an existing engine_cart:generate task

data/template.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 # Hack for https://github.com/rails/rails/issues/35153
 gsub_file 'Gemfile', /^gem ["']sqlite3["']$/, 'gem "sqlite3", "~> 1.3.0"'
-gem 'hyrax', '3.4.1'
+gem 'hyrax', '4.0.0.beta1'
 run 'bundle install'
 generate 'hyrax:install', '-f'