RubyGems - hyrax - Versions diffs - 3.0.0.pre.beta2 → 3.0.0.pre.beta3 - Mend

hyrax 3.0.0.pre.beta2 → 3.0.0.pre.beta3

Files changed (441) hide show

data/lib/generators/hyrax/templates/config/initializers/riiif.rb CHANGED Viewed

@@ -6,10 +6,10 @@ Riiif::Image.info_service = lambda do |id, _file|
   # Capture everything before the first slash
   fs_id = id.sub(/\A([^\/]*)\/.*/, '\1')
-  resp = ActiveFedora::SolrService.get("id:#{fs_id}")
+  resp = Hyrax::SolrService.get("id:#{fs_id}")
   doc = resp['response']['docs'].first
   raise "Unable to find solr document with id:#{fs_id}" unless doc
-  { height: doc['height_is'], width: doc['width_is'] }
+  { height: doc['height_is'], width: doc['width_is'], format: doc['mime_type_ssi'], channels: doc['alpha_channels_ssi'] }
 end
 Riiif::Image.file_resolver.id_to_uri = lambda do |id|
@@ -23,4 +23,4 @@ Riiif::Image.authorization_service = Hyrax::IIIFAuthorizationService
 Riiif.not_found_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
 Riiif.unauthorized_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
-Riiif::Engine.config.cache_duration_in_days = 365
+Riiif::Engine.config.cache_duration = 365.days

data/lib/generators/hyrax/templates/config/solr_wrapper_valkyrie_test.yml ADDED Viewed

@@ -0,0 +1,7 @@
+# config/solr_wrapper_valkyrie_test.yml
+port: 8987
+instance_dir: tmp/solr-valkyrie-test
+collection:
+    persist: false
+    dir: solr/conf
+    name: hyrax-valkyrie-test

data/lib/generators/hyrax/templates/config/valkyrie_index.yml ADDED Viewed

@@ -0,0 +1,12 @@
+development:
+  host: <%= ENV['VALKYRIE_SOLR_HOST'] %>
+  port: <%= ENV['VALKYRIE_SOLR_PORT'] %>
+  core: <%= ENV['VALKYRIE_SOLR_CORE'] || 'hyrax-valkyrie-dev' %>
+test:
+  host: <%= ENV['VALKYRIE_SOLR_HOST'] %>
+  port: <%= ENV['VALKYRIE_SOLR_PORT'] || 8987 %>
+  core: <%= ENV['VALKYRIE_SOLR_CORE'] || 'hyrax-valkyrie-test' %>
+production:
+  host: <%= ENV['VALKYRIE_SOLR_HOST'] %>
+  port: <%= ENV['VALKYRIE_SOLR_PORT'] %>
+  core: <%= ENV['VALKYRIE_SOLR_CORE'] %>

data/lib/generators/hyrax/templates/package.json ADDED Viewed

@@ -0,0 +1,17 @@
+{
+  "name": "hyrax",
+  "private": true,
+  "repository": "git@github.com:samvera/hyrax.git",
+  "dependencies": {
+  "universalviewer": "^3.0.16"
+},
+"scripts": {
+  "preinstall": "rm -rf ./public/uv",
+  "postinstall": "yarn run uv-install && yarn run uv-config",
+  "uv-install": "shx cp -r ./node_modules/universalviewer/uv ./public/",
+  "uv-config": "shx cp ./config/uv/uv.html ./public/uv/uv.html & shx cp ./config/uv/uv-config.json ./public/uv/"
+  },
+  "devDependencies": {
+  "shx": "^0.3.2"
+  }
+}

data/lib/generators/hyrax/templates/uv-config.json ADDED Viewed

@@ -0,0 +1,3 @@
+{
+}

data/lib/generators/hyrax/templates/uv.html ADDED Viewed

@@ -0,0 +1,87 @@
+<!--
+    This is what the embed iframe src links to. It doesn't need to communicate with the parent page, only fill the available space and look for #? parameters
+-->
+<html>
+    <head>
+        <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
+        <link rel="icon" href="favicon.ico">
+        <link rel="stylesheet" type="text/css" href="uv.css">
+        <script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
+        <script type="text/javascript" src="lib/offline.js"></script>
+        <script type="text/javascript" src="helpers.js"></script>
+        <style>
+            body {
+                margin: 0;
+                padding: 0;
+                overflow: hidden;
+            }
+        </style>
+        <script type="text/javascript">
+        window.addEventListener('uvLoaded', function(e) {
+                urlDataProvider = new UV.URLDataProvider(true);
+                var formattedLocales;
+                var locales = urlDataProvider.get('locales', '');
+                if (locales) {
+                    var names = locales.split(',');
+                    formattedLocales = [];
+                    for (var i in names) {
+                        var nameparts = String(names[i]).split(':');
+                        formattedLocales[i] = {name: nameparts[0], label: nameparts[1]};
+                    }
+                } else {
+                    formattedLocales = [
+                        {
+                            name: 'en-GB'
+                        }
+                    ]
+                }
+                uv = createUV('#uv', {
+                    root: '.',
+                    iiifResourceUri: urlDataProvider.get('manifest'),
+                    configUri: urlDataProvider.get('config'),
+                    collectionIndex: Number(urlDataProvider.get('c', 0)),
+                    manifestIndex: Number(urlDataProvider.get('m', 0)),
+                    sequenceIndex: Number(urlDataProvider.get('s', 0)),
+                    canvasIndex: Number(urlDataProvider.get('cv', 0)),
+                    rangeId: urlDataProvider.get('rid', 0),
+                    rotation: Number(urlDataProvider.get('r', 0)),
+                    xywh: urlDataProvider.get('xywh', ''),
+                    embedded: true,
+                    locales: formattedLocales
+                }, urlDataProvider);
+            }, false);
+        </script>
+    </head>
+    <body>
+        <div id="uv" class="uv"></div>
+        <script>
+            $(function() {
+                var $UV = $('#uv');
+                function resize() {
+                    var windowWidth = window.innerWidth;
+                    var windowHeight = window.innerHeight;
+                    $UV.width(windowWidth);
+                    $UV.height(windowHeight);
+                }
+                $(window).on('resize' ,function() {
+                    resize();
+                });
+                resize();
+            });
+        </script>
+        <script type="text/javascript" src="uv.js"></script>
+    </body>
+</html>

data/lib/generators/hyrax/work/templates/feature_spec.rb.erb CHANGED Viewed

@@ -50,7 +50,6 @@ RSpec.feature 'Create a <%= class_name %>', js: false do
       click_link "Descriptions" # switch tab
       fill_in('Title', with: 'My Test Work')
       fill_in('Creator', with: 'Doe, Jane')
-      fill_in('Keyword', with: 'testing')
       select('In Copyright', from: 'Rights statement')
       # With selenium and the chrome driver, focus remains on the

data/lib/hyrax.rb CHANGED Viewed

@@ -49,10 +49,26 @@ module Hyrax
   ##
   # @return [Logger]
   def self.logger
-    @logger ||= ActiveFedora::Base.logger
+    @logger ||= Valkyrie.logger
   end
   def self.primary_work_type
     config.curation_concerns.first
   end
+  def self.persister
+    metadata_adapter.persister
+  end
+  def self.metadata_adapter
+    Valkyrie.config.metadata_adapter
+  end
+  def self.storage_adapter
+    Valkyrie.config.storage_adapter
+  end
+  def self.query_service
+    metadata_adapter.query_service
+  end
 end

data/lib/hyrax/configuration.rb CHANGED Viewed

@@ -189,7 +189,10 @@ module Hyrax
     def whitelisted_ingest_dirs
       @whitelisted_ingest_dirs ||= \
         if defined? BrowseEverything
-          Array.wrap(BrowseEverything.config['file_system'].try(:[], :home)).compact
+          file_system_dirs = Array.wrap(BrowseEverything.config['file_system'].try(:[], :home)).compact
+          # Include the Rails tmp directory for cases where the BrowseEverything provider is required to download the file to a temporary directory first
+          tmp_dir = [Rails.root.join('tmp').to_s]
+          file_system_dirs + tmp_dir
         else
           []
         end
@@ -222,24 +225,6 @@ module Hyrax
       registered_curation_concern_types.map(&:constantize)
     end
-    # The MetadataAdapter to use when persisting resources with Valkyrie
-    #
-    # @see lib/wings
-    # @see https://github.com/samvera-labs/valkyrie
-    def valkyrie_metadata_adapter
-      @valkyrie_metadata_adapter ||= :wings_adapter
-    end
-    attr_writer :valkyrie_metadata_adapter
-    # The StorageAdapter to use when persisting resources with Valkyrie
-    #
-    # @see lib/wings
-    # @see https://github.com/samvera-labs/valkyrie
-    def valkyrie_storage_adapter
-      @valkyrie_storage_adapter ||= :fedora
-    end
-    attr_writer :valkyrie_storage_adapter
     # A configuration point for changing the behavior of the license service.
     #
     # @!attribute [w] license_service_class
@@ -384,6 +369,11 @@ module Hyrax
       @cache_path ||= ->() { Rails.root + 'tmp' + 'uploads' + 'cache' }
     end
+    attr_writer :id_field
+    def id_field
+      @id_field || index_field_mapper.id_field
+    end
     # Enable IIIF image service. This is required to use the
     # IIIF viewer enabled show page
     #
@@ -410,7 +400,7 @@ module Hyrax
     #
     # @return [#call] lambda/proc that generates a URL to an image
     def iiif_image_url_builder
-      @iiif_image_url_builder ||= ->(file_id, base_url, _size) { "#{base_url}/downloads/#{file_id.split('/').first}" }
+      @iiif_image_url_builder ||= ->(file_id, base_url, _size, _format) { "#{base_url}/downloads/#{file_id.split('/').first}" }
     end
     attr_writer :iiif_image_url_builder
@@ -446,6 +436,11 @@ module Hyrax
     end
     attr_writer :iiif_metadata_fields
+    attr_writer :index_field_mapper
+    def index_field_mapper
+      @index_field_mapper ||= ActiveFedora.index_field_mapper
+    end
     # Should a button with "Share my work" show on the front page to users who are not logged in?
     attr_writer :display_share_button_when_not_logged_in
     def display_share_button_when_not_logged_in?
@@ -497,6 +492,15 @@ module Hyrax
       end
     end
+    attr_writer :resource_id_to_uri_transformer
+    def resource_id_to_uri_transformer
+      @resource_id_to_uri_transformer ||= lambda do |resource, base_url|
+        file_id = CGI.escape(resource.file_identifiers.first.to_s)
+        fs_id = CGI.escape(resource.file_set_id.to_s)
+        "#{base_url}#{::Noid::Rails.treeify(fs_id)}/files/#{file_id}"
+      end
+    end
     attr_writer :contact_email
     def contact_email
       @contact_email ||= "repo-admin@example.org"
@@ -529,6 +533,16 @@ module Hyrax
       ->(id:, extent:) { Samvera::NestingIndexer.reindex_relationships(id: id, extent: extent) }
     end
+    attr_writer :solr_select_path
+    def solr_select_path
+      @solr_select_path ||= ActiveFedora.solr_config.fetch(:select_path, 'select')
+    end
+    attr_writer :query_index_from_valkyrie
+    def query_index_from_valkyrie
+      @query_index_from_valkyrie ||= false
+    end
     private
       # @param [Symbol, #to_s] model_name - symbol representing the model

data/lib/hyrax/engine.rb CHANGED Viewed

@@ -2,9 +2,11 @@ module Hyrax
   class Engine < ::Rails::Engine
     isolate_namespace Hyrax
-    # These gems must be required outside of an initializer or they don't get loaded.
     require 'awesome_nested_set'
     require 'breadcrumbs_on_rails'
+    require 'dry/struct'
+    require 'dry/equalizer'
+    require 'dry/validation'
     require 'jquery-ui-rails'
     require 'flot-rails'
     require 'almond-rails'
@@ -13,7 +15,11 @@ module Hyrax
     require 'qa'
     require 'clipboard/rails'
     require 'legato'
-    require 'pul_uv_rails'
+    require 'hydra/derivatives'
+    require 'hyrax/controller_resource'
+    require 'hyrax/search_state'
+    require 'hyrax/errors'
     # Force these models to be added to Legato's registry in development mode
     config.eager_load_paths += %W[
@@ -23,7 +29,9 @@ module Hyrax
     config.action_dispatch.rescue_responses.merge!(
       "ActiveFedora::ObjectNotFoundError" =>     :not_found, # We can remove this when we use ActiveFedora 11.2
-      "Blacklight::Exceptions::RecordNotFound" => :not_found
+      "Blacklight::Exceptions::RecordNotFound" => :not_found,
+      "Valkyrie::Persistence::ObjectNotFoundError" => :not_found,
+      "Hyrax::ObjectNotFoundError" => :not_found
     )
     config.before_initialize do
@@ -62,14 +70,8 @@ module Hyrax
     end
     initializer 'requires' do
-      require 'hydra/derivatives'
-      require 'hyrax/controller_resource'
-      require 'hyrax/search_state'
-      require 'hyrax/errors'
       require 'power_converters'
-      require 'dry/struct'
-      require 'dry/equalizer'
-      require 'dry/validation'
+      require 'wings'
       begin
         require 'valkyrie'
       rescue LoadError

data/lib/hyrax/errors.rb CHANGED Viewed

@@ -1,4 +1,6 @@
 module Hyrax
+  require 'active_fedora/errors'
   # Generic Hyrax exception class.
   class HyraxError < StandardError; end
@@ -8,4 +10,6 @@ module Hyrax
   class WorkflowAuthorizationException < HyraxError; end
   class SingleUseError < HyraxError; end
+  class ObjectNotFoundError < ActiveFedora::ObjectNotFoundError; end
 end

data/lib/hyrax/transactions/container.rb CHANGED Viewed

@@ -20,7 +20,9 @@ module Hyrax
     class Container
       require 'hyrax/transactions/create_work'
       require 'hyrax/transactions/destroy_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_admin_set'
       require 'hyrax/transactions/steps/ensure_permission_template'
@@ -31,11 +33,21 @@ module Hyrax
       extend Dry::Container::Mixin
+      # Disable BlockLength rule for DSL code
+      # rubocop:disable Metrics/BlockLength
       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
@@ -64,6 +76,7 @@ module Hyrax
           Steps::SetUploadedDate.new
         end
       end
+      # rubocop:enable Metrics/BlockLength
     end
   end
 end

data/lib/hyrax/transactions/create_work.rb CHANGED Viewed

@@ -33,12 +33,23 @@ module Hyrax
     #     .or { |error| handle_error(error) }
     #
     # @see https://dry-rb.org/gems/dry-transaction/
+    #
+    # @todo add collection membership handling (@see CollectionsMembershipActor)
+    # @todo set depositor (@see BaseActor)
+    # @todo initialize workflow after save (@see BaseActor)
+    # @todo add to parent works post-save (see: 'AddToWorkActor`)
+    # @todo attach files (see: 'CreateWithFilesActor`, `CreateWithRemoteFilesActor`
+    # @todo validate PermissionTemplate against visibility, lease, and embargo (see: `InterpretVisibilityActor`)
+    # @todo add locking/transactionality. Just do better than the Actor Stack
+    # @todo add support for proxy deposit (see: TransferRequestActor)
     class CreateWork
       include Dry::Transaction(container: Hyrax::Transactions::Container)
       step :set_default_admin_set,     with: 'work.set_default_admin_set'
       step :ensure_admin_set,          with: 'work.ensure_admin_set'
       step :apply_permission_template, with: 'work.apply_permission_template'
+      step :apply_collection_template, with: 'work.apply_collection_permission_template'
+      step :apply_visibility,          with: 'work.apply_visibility'
       step :set_modified_date,         with: 'work.set_modified_date'
       step :set_uploaded_date,         with: 'work.set_uploaded_date'
       step :save_work,                 with: 'work.save_work'

data/lib/hyrax/transactions/steps/apply_collection_permission_template.rb ADDED Viewed

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module Hyrax
+  module Transactions
+    module Steps
+      ##
+      # A `dry-transcation` step that applies permission templates for a set of
+      # collections on a given work.
+      #
+      # @since 3.0.0
+      class ApplyCollectionPermissionTemplate
+        include Dry::Transaction::Operation
+        ##
+        # @param [Hyrax::WorkBehavior] work
+        # @param [Array<#permision_template>] collections  a list of collections for which
+        #   permission templates should be applied
+        #
+        # @return [Dry::Monads::Result]
+        def call(work, collections: [])
+          collections.each do |collection|
+            template = Hyrax::PermissionTemplate.find_by!(source_id: collection.id)
+            Hyrax::PermissionTemplateApplicator.apply(template).to(model: work)
+          end
+          Success(work)
+        rescue ActiveRecord::RecordNotFound => err
+          Failure(err)
+        end
+      end
+    end
+  end
+end