hyrax 4.0.0.beta2 → 4.0.0.rc2

data/documentation/MAINTENANCE.md

@@ -0,0 +1,77 @@
+# Maintenance Policy for Hyrax
+January 25, 2023
+
+[Hyrax Maintenance Working Group](https://samvera.atlassian.net/wiki/spaces/samvera/pages/496632295/Hyrax+Maintenance+Working+Group)
+
+## Why do we need a policy? 
+A written policy prevents word-of-mouth policies which create confusion in the community. 
+A written policy also provides a transparent way to communicate our values to people who may 
+not work on the maintenance team consistently. It gives a basis to justify spending time on 
+something that isn’t in the product backlog.
+
+Updated versions of JavaScript libraries, Ruby, and Ruby gems are released all the time. 
+If we don’t keep our applications up-to-date with the latest released versions of their 
+dependencies, we may end up with applications that rely on dependencies with known 
+vulnerabilities, bugs, or deprecated features.
+
+Hyrax releases are managed in two groupings: 
+- Breaking changes which include new features with incompatible changes such as requiring 
+  data migration, bug fixes or security fixes with incompatible changes. 
+- Non-breaking changes which have new features that can be introduced with feature flipper, 
+  backwards compatibility, or that do not require data migration, bug fixes or security fixes
+  that do not require data migration. 
+
+## Semantic Versioning
+
+Hyrax follows [semver](https://semver.org/) for release versioning. All releases are handled in X.Y.Z format.
+
+Current releases are at https://github.com/samvera/hyrax/releases 
+
+### Major X
+New features with incompatible changes such as requiring data migration, bug fixes or security 
+fixes with incompatible changes. Breaking changes are paired with deprecation notices in the 
+previous minor or major release.
+
+### Minor Y
+New features that can be introduced with feature flipper, backwards compatibility, or that do not 
+require data migration. May also contain bug fixes or security fixes that do not require data migration.
+
+### Patch Z
+Bug fixes or security fixes that do not require data migration. No new features.
+
+## Supported Versions
+Supported versions are the highest currently released X version and then backwards to X-1. So when 
+Hyrax 4.0 is released, the latest Hyrax 3.y is supported but Hyrax 2.y is not. Extended support for 
+an otherwise unsupported version may be offered at the Product Owner or Technical Lead’s discretion. 
+See End-of-Life Versions below.
+
+## New features
+New features that are added to the current release may be backported to supported past versions on 
+a case-by-case basis. New features that are not relevant to the current release can be added to a 
+supported past version.
+
+## Bug fixes
+Bug fixes that are added to the current release may be backported to supported past versions on a 
+case-by-case basis. 
+
+## Security fixes
+The current major release will receive patches and new versions in case of a security fix. The last
+release in the previous major version will also receive security updates. So when Hyrax 4.y has a 
+security fix applied, this security fix would also be applied to the latest Hyrax 3.y, but not to 
+Hyrax 2.y.
+
+## Dependency Management
+Deprecated or end-of-life versions of dependencies used as part of building a Hyrax-based application 
+will be removed from the test suite to manage maintenance. If an outdated version of a dependency is 
+still supported that does not pose security issues, it may remain supported in the test suite.
+
+## End-of-Life  Versions
+End-of-life versions are X-1 versions behind the highest currently released X version. So when Hyrax 4.0 
+is released, Hyrax 2.y is end-of-life and no longer supported, but Hyrax 3.y is still supported and is 
+not end-of-life. Extended support for an otherwise unsupported version may be offered at the Product 
+Owner or Technical Lead’s discretion (e.g. many major releases in a short period of time). 
+See Supported Versions above.
+
+End-of-Life versions of Hyrax will not be supported. Applying fixes (security or otherwise) will be 
+up to the implementing entity. We encourage updating to supported versions of Hyrax to receive updates 
+and security fixes.

data/documentation/developing-your-hyrax-based-app.md

@@ -30,7 +30,7 @@ A Hyrax-based application includes lots of dependencies. We provide a [Docker im
 You can also try [Running Hyrax-based application in local VM](https://github.com/samvera/hyrax/wiki/Hyrax-Development-Guide#running-hyrax-based-application-in-local-vm) which uses Ubuntu.
 
 This document contains instructions specific to setting up an app with __Hyrax
-v3.0.1__. If you are looking for instructions on installing a different
+v4.0.0.rc1__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 
@@ -125,7 +125,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v4.0.0.beta2/template.rb
+rails _6.1.7.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v4.0.0.rc1/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/documentation/legacyREADME.md

@@ -50,7 +50,7 @@ The Samvera community is here to help. Please see our [support guide](../.github
 # Getting started
 
 This document contains instructions specific to setting up an app with __Hyrax
-v4.0.0.beta2__. If you are looking for instructions on installing a different
+v4.0.0.rc2__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 
@@ -129,7 +129,7 @@ Note here that the following commands assume you're setting up Hyrax in a develo
 
 First, you'll need a working Ruby installation. You can install this via your operating system's package manager -- you are likely to get farther with OSX, Linux, or UNIX than Windows but your mileage may vary -- but we recommend using a Ruby version manager such as [RVM](https://rvm.io/) or [rbenv](https://github.com/sstephenson/rbenv).
 
-Hyrax supports Ruby 2.5, 2.6, and 2.7. When starting a new project, we recommend using the latest Ruby 2.7 version.
+Hyrax supports Ruby 2.7, 3.0, 3.1 and 3.2. When starting a new project, we recommend using the latest Ruby 3.2 version.
 
 ## Redis
 
@@ -159,7 +159,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.0.2/template.rb
+rails _6.1.7.3_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v4.0.0.rc2/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/hyrax.gemspec

@@ -32,7 +32,7 @@ SUMMARY
   # http://guides.rubyonrails.org/maintenance_policy.html
   spec.add_dependency 'rails', '~> 6.0'
 
-  spec.add_dependency 'active-fedora', '~> 13.1', '>= 13.1.2'
+  spec.add_dependency 'active-fedora', '~> 14.0'
   spec.add_dependency 'almond-rails', '~> 0.1'
   spec.add_dependency 'awesome_nested_set', '~> 3.1'
   spec.add_dependency 'blacklight', '~> 7.29'
@@ -44,8 +44,8 @@ SUMMARY
   spec.add_dependency 'draper', '~> 4.0'
   spec.add_dependency 'dry-events', '~> 0.2.0'
   spec.add_dependency 'dry-equalizer', '~> 0.2'
+  spec.add_dependency 'dry-monads', '~> 1.5'
   spec.add_dependency 'dry-struct', '~> 1.0'
-  spec.add_dependency 'dry-transaction', '~> 0.11'
   spec.add_dependency 'dry-validation', '~> 1.3'
   spec.add_dependency 'flipflop', '~> 2.3'
   # Pin more tightly because 0.x gems are potentially unstable
@@ -53,37 +53,34 @@ SUMMARY
   spec.add_dependency 'font-awesome-rails', '~> 4.2'
   spec.add_dependency 'hydra-derivatives', '~> 3.3'
   spec.add_dependency 'hydra-editor', '~> 6.0'
-  spec.add_dependency 'hydra-file_characterization', '~> 1.1.2'
+  spec.add_dependency 'hydra-file_characterization', '~> 1.1'
   spec.add_dependency 'hydra-head', '~> 12.0'
   spec.add_dependency 'hydra-works', '>= 0.16'
   spec.add_dependency 'iiif_manifest', '>= 0.3', '< 2.0'
   spec.add_dependency 'json-schema' # for Arkivo
-  # Pin more tightly because 0.x gems are potentially unstable
-  spec.add_dependency 'kaminari_route_prefix', '~> 0.1.1'
   spec.add_dependency 'legato', '~> 0.3'
   spec.add_dependency 'linkeddata' # Required for getting values from geonames
   spec.add_dependency 'mailboxer', '~> 0.12'
   spec.add_dependency 'nest', '~> 3.1'
-  spec.add_dependency 'noid-rails', '~> 3.0.0'
+  spec.add_dependency 'noid-rails', '~> 3.0'
   spec.add_dependency 'oauth'
   spec.add_dependency 'oauth2', '~> 1.2'
   spec.add_dependency 'openseadragon'
   spec.add_dependency 'posix-spawn'
-  spec.add_dependency 'power_converter', '~> 0.1', '>= 0.1.2'
   spec.add_dependency 'qa', '~> 5.5', '>= 5.5.1' # questioning_authority
   spec.add_dependency 'rails_autolink', '~> 1.1'
   spec.add_dependency 'rdf-rdfxml' # controlled vocabulary importer
   spec.add_dependency 'rdf-vocab', '~> 3.0'
   spec.add_dependency 'redis', '~> 4.0'
   spec.add_dependency 'redis-namespace', '~> 1.5'
-  spec.add_dependency 'redlock', '>= 0.1.2'
+  spec.add_dependency 'redlock', '>= 0.1.2', '< 2.0'
   spec.add_dependency 'reform', '~> 2.3'
   spec.add_dependency 'reform-rails', '~> 0.2.0'
   spec.add_dependency 'retriable', '>= 2.9', '< 4.0'
-  spec.add_dependency 'samvera-nesting_indexer', '~> 2.0'
   spec.add_dependency 'signet'
   spec.add_dependency 'tinymce-rails', '~> 5.10'
-  spec.add_dependency 'valkyrie', '~> 2', '>= 2.1.1'
+  spec.add_dependency 'valkyrie', '~> 3.0.1'
+  spec.add_dependency 'view_component', '~> 2.74.1' # Pin until blacklight is updated with workaround for https://github.com/ViewComponent/view_component/issues/1565
   spec.add_dependency 'sprockets', '~> 3.7'
   spec.add_dependency 'sass-rails', '~> 6.0'
   spec.add_dependency 'select2-rails', '~> 3.5'

data/lib/generators/hyrax/templates/catalog_controller.rb

@@ -19,7 +19,7 @@ class CatalogController < ApplicationController
 
     # Because too many times on Samvera tech people raise a problem regarding a failed query to SOLR.
     # Often, it's because they inadvertently exceeded the character limit of a GET request.
-    config.http_method = :post
+    config.http_method = Hyrax.config.solr_default_method
 
     ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params
     config.default_solr_params = {

data/lib/hyrax/configuration.rb

@@ -846,6 +846,11 @@ module Hyrax
       @solr_select_path ||= ActiveFedora.solr_config.fetch(:select_path, 'select')
     end
 
+    attr_writer :solr_default_method
+    def solr_default_method
+      @solr_default_method ||= :post
+    end
+
     attr_writer :identifier_registrars
     def identifier_registrars
       @identifier_registrars ||= {}
@@ -875,6 +880,17 @@ module Hyrax
       @derivative_services ||= [Hyrax::FileSetDerivativesService]
     end
 
+    attr_writer :visibility_map
+    # A mapping from visibility string values to permissions; the default and
+    # reference implementation is provided by {Hyrax::VisibilityMap}.
+    #
+    # @return [Hyrax::VisibilityMap]
+    # @see Hyrax::VisibilityReader
+    # @see Hyrax::VisibilityWriter
+    def visibility_map
+      @visibility_map ||= Hyrax::VisibilityMap.instance
+    end
+
     private
 
     # @param [Symbol, #to_s] model_name - symbol representing the model

data/lib/hyrax/controlled_vocabularies/resource_label_caching.rb

@@ -27,7 +27,7 @@ module Hyrax
       # @note adds behavior to clear the cache whenever a manual fetch of data
       #   is performed.
       # @see ActiveTriples::Resource#fetch
-      def fetch(*)
+      def fetch(*, **)
         Rails.cache.delete(cache_key)
         super
       end

data/lib/hyrax/engine.rb

@@ -87,7 +87,6 @@ module Hyrax
     end
 
     initializer 'requires' do
-      require 'power_converters'
       require 'wings' unless Hyrax.config.disable_wings
     end
 
@@ -108,6 +107,8 @@ module Hyrax
 
         ActiveFedora::Base.translate_uri_to_id = c.translate_uri_to_id
         ActiveFedora::Base.translate_id_to_uri = c.translate_id_to_uri
+        ActiveFedora::File.translate_uri_to_id = c.translate_uri_to_id
+        ActiveFedora::File.translate_id_to_uri = c.translate_id_to_uri
 
         ::Noid::Rails.config.template = c.noid_template
         ::Noid::Rails.config.minter_class = c.noid_minter_class

data/lib/hyrax/transactions/container.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
-require "dry/transaction"
-require "dry/transaction/operation"
 
 module Hyrax
   module Transactions

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

@@ -9,7 +9,7 @@ module Hyrax
       # to be used as a the banner for the collection.
       #
       class SaveCollectionBanner
-        include Dry::Transaction::Operation
+        include Dry::Monads[:result]
 
         ##
         # @param [Hyrax::ChangeSet] change_set

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

@@ -9,7 +9,7 @@ module Hyrax
       # to be used as logo(s) for the collection.
       #
       class SaveCollectionLogo
-        include Dry::Transaction::Operation
+        include Dry::Monads[:result]
 
         ##
         # @param [Hyrax::ChangeSet] change_set

data/lib/hyrax/transactions/transaction.rb

@@ -95,7 +95,8 @@ module Hyrax
       def call(value)
         Success(
           steps.inject(value) do |val, step_name|
-            yield container[step_name].call(val, *step_arguments_for(step_name))
+            args = step_arguments_for(step_name)
+            yield container[step_name].call(val, *args[0..-2], **Hash(args[-1]))
           end
         )
       end
@@ -119,7 +120,7 @@ module Hyrax
       #   tx = Hyrax::Transactions::Transaction.new(steps: [:first_step, :second_step])
       #   result = tx.with_step_args(second_step: {named_parameter: :param_value}).call(:value)
       #
-      def with_step_args(args)
+      def with_step_args(**args)
         raise(ArgumentError, key_err_msg(args.keys)) if
           args.keys.any? { |key| !step?(key) }
 

data/lib/hyrax/version.rb

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

data/lib/hyrax.rb

@@ -20,7 +20,6 @@ require 'hyrax/version'
 require 'hyrax/inflections'
 require 'hyrax/name'
 require 'hyrax/valkyrie_can_can_adapter'
-require 'kaminari_route_prefix'
 require 'valkyrie/indexing_adapter'
 require 'valkyrie/indexing/solr/indexing_adapter'
 require 'valkyrie/indexing/null_indexing_adapter'

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

@@ -62,7 +62,7 @@ module Valkyrie
             # generator now (if not, the application has bigger problems
             # than this missing configuration)
             bl_index = Blacklight.default_index.connection.uri
-          rescue RuntimeError
+          rescue StandardError
             return {}
           end
 

data/lib/wings/active_fedora_converter/file_metadata_node.rb

@@ -9,7 +9,7 @@ module Wings
         # 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
+            key.name == :size || key.name == :has_model
         end
 
         Wings::ActiveFedoraConverter.apply_properties(self, schema)

data/lib/wings/valkyrie/storage.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'faraday/multipart'
+
 module Wings
   module Valkyrie
     ##
@@ -67,8 +69,9 @@ module Wings
 
         reader = RDF::Reader.for(content_type: response.headers['content-type'])
         version_graph = RDF::Graph.new << reader.new(response.body)
+        query = { predicate: RDF::Vocab::Fcrepo4.hasVersion }
 
-        version_graph.query(predicate: RDF::Vocab::Fcrepo4.hasVersion).objects.map do |uri|
+        version_graph.query(query).objects.map do |uri|
           timestamp =
             version_graph.query([uri, RDF::Vocab::Fcrepo4.created, :created])
                          .first_object