hyrax 5.0.0.rc2 → 5.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 951cca50f478f6a77b0b4dfd7f7127de250891ae5f26af3d0aad431e84987506
-  data.tar.gz: 4748c1f1c6a6a744e9ddbf364de06d028548f3699aa5a25c33104259672b412d
+  metadata.gz: 020c1b9b867c89474795692fb51cc03751ecfd10feb8dd300750b12891b3687c
+  data.tar.gz: 41385b0600e001653ed3eb30b239b1520125fb52192af6543d6be53ffb76d0e4
 SHA512:
-  metadata.gz: e24d5fd70134e1c27b39cd266a51b18838fc8b29d815b91d9df80e96c53f5348ba0b87647cf15894886de61ac4c7e49afbb4ecb9b9708b38f74959d74b339480
-  data.tar.gz: 745e7abf8b5f773864867f91b75f74a1768c97dddd7de35085b65d7dae48513bc2b06dd233365de9445940ebc3af9ad01bd53276e6b58bd4fcffc217e63aaa94
+  metadata.gz: 1c56457afe4451c9bd228ef1b45e2d431c60855ba1b744c14f4320ceefa92020d9c4bff083d0d39271c8e8cf2d3db3a79ff0630ece9f676180c21a6b928fee13
+  data.tar.gz: 144eda52bc5bee7caba33a113324e27fa5c00102c9422264758f68ab28f59844d6a1bb8ff6301d251cd17fc34e6e8cc4aa089c1b22c11249d3988070e935dcb8

data/.circleci/config.yml

@@ -119,6 +119,7 @@ jobs:
       HYRAX_VALKYRIE: << parameters.hyrax_valkyrie >>
       IN_DOCKER: true
       KARMA_BROWSER: remote-chromium
+      SOLR_URL: http://127.0.0.1:8985/solr/hydra-test
       VALKYRIE_SOLR_CORE: valkyrie-test
       VALKYRIE_SOLR_PORT: 8985
     steps:
@@ -165,3 +166,16 @@ workflows:
           hyrax_valkyrie: "1"
           requires:
             - dassie-build
+
+  koppie:
+    jobs:
+      - kaniko-build:
+          name: "koppie-build"
+          ruby_version: "3.2.2"
+          hyrax_app: "koppie"
+      - hyrax-test:
+          name: "koppie-test"
+          ruby_version: "3.2.2"
+          hyrax_app: "koppie"
+          requires:
+            - koppie-build

data/.dassie/app/listeners/hyrax_listener.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+##
+# Generated by hyrax:listeners
+#
+# The Hyrax engine uses a publish/subscribe programming model to allow
+# pluggable behavior in response to certain repository events. A range of events
+# are published on a topic based event bus.
+#
+# This listener provides a template.
+#
+# For simple use cases, it's fine to add behavior to the `#on_*` methods in this
+# Listener. If you have more than trivial behavior here, you probably want to add
+# new classes that are named narrowly scoped and named for what the listener is
+# for.
+#
+# When writing listener methods, it's important to carefully consider error,
+# handling. Unhandled exceptions short-circuit behavior for other listeners,
+# so it's a good idea to be paying attention to failure cases.
+#
+# @see https://github.com/samvera/hyrax/wiki/Hyrax's-Event-Bus-(Hyrax::Publisher)
+# @see https://www.rubydoc.info/gems/hyrax/Hyrax/Publisher
+# @see https://dry-rb.org/gems/dry-events
+class HyraxListener
+  # def on_batch_created
+  # end
+
+  # def on_collection_deleted
+  # end
+
+  # def on_collection_metadata_updated
+  # end
+
+  # def on_collection_membership_update
+  # end
+
+  # def on_file_characterized
+  # end
+
+  # def on_file_downloaded
+  # end
+
+  # def on_file_metadata_updated
+  # end
+
+  # def on_file_metadata_deleted
+  # end
+
+  # def on_file_uploaded
+  # end
+
+  # def on_file_set_audited
+  # end
+
+  # def on_file_set_attached
+  # end
+
+  # def on_file_set_url_imported
+  # end
+
+  # def on_file_set_restored
+  # end
+
+  # def on_object_deleted
+  # end
+
+  # def on_object_failed_deposit
+  # end
+
+  # def on_object_deposited
+  # end
+
+  # def on_object_acl_updated
+  # end
+
+  # def on_object_membership_updated
+  # end
+
+  # def on_object_metadata_updated
+  # end
+end

data/.dassie/config/environments/test.rb

@@ -1,5 +1,3 @@
-require 'hyrax/specs/disable_animations_in_test_environment'
-
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
   config.assets.debug = true
@@ -46,7 +44,4 @@ Rails.application.configure do
 
   # Raises error for missing translations
   config.action_view.raise_on_missing_translations = true
-
-  # disable animations with shared hyrax code
-  config.middleware.use DisableAnimationsInTestEnvironment
 end

data/.dassie/config/initializers/hyrax.rb

@@ -63,6 +63,11 @@ Hyrax.config do |config|
   # config.collection_model = 'Hyrax::PcdmCollection' # collection without basic metadata
   # config.collection_model = 'CollectionResource'    # collection with basic metadata
   # config.admin_set_model = 'Hyrax::AdministrativeSet'
+
+  # dassie needs legacy AF models
+  config.collection_model = '::Collection'
+  config.admin_set_model = 'AdminSet'
+  config.file_set_model = '::FileSet'
 end
 
 Date::DATE_FORMATS[:standard] = "%m/%d/%Y"

data/.dassie/config/initializers/publisher.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+# Hyrax.publisher.subscribe(HyraxListener.new)

data/.dassie/config/initializers/riiif.rb

@@ -31,3 +31,80 @@ Rails.application.reloader.to_prepare do
 
   Riiif::Engine.config.cache_duration = 1.day
 end
+
+module Hyrax
+  # Adds file locking to Riiif::File
+  # @see RiiifFileResolver
+  class RiiifFile < Riiif::File
+    include ActiveSupport::Benchmarkable
+
+    attr_reader :id
+    def initialize(input_path, tempfile = nil, id:)
+      super(input_path, tempfile)
+      raise(ArgumentError, "must specify id") if id.blank?
+      @id = id
+    end
+
+    # Wrap extract in a read lock and benchmark it
+    def extract(transformation, image_info = nil)
+      Riiif::Image.file_resolver.file_locks[id].with_read_lock do
+        benchmark "RiiifFile extracted #{path} with #{transformation.to_params}", level: :debug do
+          super
+        end
+      end
+    end
+
+    private
+
+    def logger
+      Hyrax.logger
+    end
+  end
+
+  class RiiifFileResolver
+    include ActiveSupport::Benchmarkable
+
+    # @param [String] id from iiif manifest
+    # @return [Riiif::File]
+    def find(id)
+      path = nil
+      file_locks[id].with_write_lock do
+        path = build_path(id)
+        path = build_path(id, force: true) unless File.exist?(path) # Ensures the file is locally available
+      end
+      RiiifFile.new(path, id: id)
+    end
+
+    # tracks individual file locks
+    # @see RiiifFile
+    # @return [Concurrent::Map<Concurrent::ReadWriteLock>]
+    def file_locks
+      @file_locks ||= Concurrent::Map.new do |k, v|
+        k.compute_if_absent(v) { Concurrent::ReadWriteLock.new }
+      end
+    end
+
+    private
+
+    def build_path(id, force: false)
+      Riiif::Image.cache.fetch("riiif:" + Digest::MD5.hexdigest("path:#{id}"),
+                               expires_in: Riiif::Image.expires_in,
+                               force: force) do
+        load_file(id)
+      end
+    end
+
+    def load_file(id)
+      benchmark "RiiifFileResolver loaded #{id}", level: :debug do
+        fs_id = id.sub(/\A([^\/]*)\/.*/, '\1')
+        file_set = Hyrax.query_service.find_by(id: fs_id)
+        file_metadata = Hyrax.custom_queries.find_original_file(file_set: file_set)
+        file_metadata.file.disk_path.to_s # Stores a local copy in tmpdir
+      end
+    end
+
+    def logger
+      Hyrax.logger
+    end
+  end
+end

data/.gitignore

@@ -10,6 +10,10 @@ Gemfile*.lock
 fcrepo4-data
 fcrepo4-test-data
 
+## JS lock files
+yarn.lock
+package-lock.json
+
 ## MAC OS
 .DS_Store
 

data/.koppie/.env

@@ -43,6 +43,6 @@ SOLR_CORES=koppie
 SOLR_HOST=solr
 SOLR_PORT=8983
 SOLR_URL=http://solr:8983/solr/koppie
-SOLR_TEST_URL=http://solr:8983/solr/koppie_test
+SOLR_TEST_URL=http://solr:8983/solr/hydra-test
 VALKYRIE_METADATA_ADAPTER=pg_metadata
-VALKYRIE_STORAGE_ADAPTER=versioned_disk_storage
+VALKYRIE_STORAGE_ADAPTER=versioned_disk_storage

data/.koppie/app/forms/collection_resource_form.rb

@@ -3,5 +3,6 @@
 # Generated via
 #  `rails generate hyrax:collection_resource CollectionResource`
 class CollectionResourceForm < Hyrax::Forms::PcdmCollectionForm
+  include Hyrax::FormFields(:basic_metadata)
   include Hyrax::FormFields(:collection_resource)
 end

data/.koppie/app/indexers/collection_resource_indexer.rb

@@ -3,5 +3,6 @@
 # Generated via
 #  `rails generate hyrax:collection_resource CollectionResource`
 class CollectionResourceIndexer < Hyrax::PcdmCollectionIndexer
+  include Hyrax::Indexer(:basic_metadata)
   include Hyrax::Indexer(:collection_resource)
 end

data/.koppie/app/listeners/hyrax_listener.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+##
+# Generated by hyrax:listeners
+#
+# The Hyrax engine uses a publish/subscribe programming model to allow
+# pluggable behavior in response to certain repository events. A range of events
+# are published on a topic based event bus.
+#
+# This listener provides a template.
+#
+# For simple use cases, it's fine to add behavior to the `#on_*` methods in this
+# Listener. If you have more than trivial behavior here, you probably want to add
+# new classes that are named narrowly scoped and named for what the listener is
+# for.
+#
+# When writing listener methods, it's important to carefully consider error,
+# handling. Unhandled exceptions short-circuit behavior for other listeners,
+# so it's a good idea to be paying attention to failure cases.
+#
+# @see https://github.com/samvera/hyrax/wiki/Hyrax's-Event-Bus-(Hyrax::Publisher)
+# @see https://www.rubydoc.info/gems/hyrax/Hyrax/Publisher
+# @see https://dry-rb.org/gems/dry-events
+class HyraxListener
+  # def on_batch_created
+  # end
+
+  # def on_collection_deleted
+  # end
+
+  # def on_collection_metadata_updated
+  # end
+
+  # def on_collection_membership_update
+  # end
+
+  # def on_file_characterized
+  # end
+
+  # def on_file_downloaded
+  # end
+
+  # def on_file_metadata_updated
+  # end
+
+  # def on_file_metadata_deleted
+  # end
+
+  # def on_file_uploaded
+  # end
+
+  # def on_file_set_audited
+  # end
+
+  # def on_file_set_attached
+  # end
+
+  # def on_file_set_url_imported
+  # end
+
+  # def on_file_set_restored
+  # end
+
+  # def on_object_deleted
+  # end
+
+  # def on_object_failed_deposit
+  # end
+
+  # def on_object_deposited
+  # end
+
+  # def on_object_acl_updated
+  # end
+
+  # def on_object_membership_updated
+  # end
+
+  # def on_object_metadata_updated
+  # end
+end

data/.koppie/app/models/collection.rb

@@ -1 +1 @@
-Collection = Hyrax::PcdmCollection
+Collection = CollectionResource

data/.koppie/app/models/collection_resource.rb

@@ -27,5 +27,6 @@ class CollectionResource < Hyrax::PcdmCollection
   # * add Valkyrie attributes to this class
   # * update form and indexer to process the attributes
   #
+  include Hyrax::Schema(:basic_metadata)
   include Hyrax::Schema(:collection_resource)
 end

data/.koppie/config/analytics.yml

@@ -1,12 +1,12 @@
 analytics:
   google:
     analytics_id: <%= ENV['GOOGLE_ANALYTICS_ID'] %>
-    app_name: <%= ENV.fetch('GOOGLE_OAUTH_APP_NAME', 'nurax-pg') %>
-    app_version: <%= ENV.fetch['GOOGLE_OAUTH_APP_VERSION'] %>
+    app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME'] %>
+    app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION'] %>
     privkey_value: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_VALUE'] %>
-    privkey_path: <%= ENV.fetch['GOOGLE_OAUTH_PRIVATE_KEY_PATH'] %>
-    privkey_secret: <%= ENV.fetch['GOOGLE_OAUTH_PRIVATE_KEY_SECRET'] %>
-    client_email: <%= ENV.fetch['GOOGLE_OAUTH_CLIENT_EMAIL'] %>
+    privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH'] %>
+    privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET'] %>
+    client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL'] %>
   matomo:
     base_url: <%= ENV['MATOMO_BASE_URL'] %>
     site_id: <%= ENV['MATOMO_SITE_ID'] %>

data/.koppie/config/initializers/publisher.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+# Hyrax.publisher.subscribe(HyraxListener.new)

data/.koppie/config/initializers/riiif.rb

@@ -31,3 +31,81 @@ Rails.application.reloader.to_prepare do
 
   Riiif::Engine.config.cache_duration = 1.day
 end
+
+module Hyrax
+  # Adds file locking to Riiif::File
+  # @see RiiifFileResolver
+  class RiiifFile < Riiif::File
+    include ActiveSupport::Benchmarkable
+
+    attr_reader :id
+    def initialize(input_path, tempfile = nil, id:)
+      super(input_path, tempfile)
+      raise(ArgumentError, "must specify id") if id.blank?
+      @id = id
+    end
+
+    # Wrap extract in a read lock and benchmark it
+    def extract(transformation, image_info = nil)
+      Riiif::Image.file_resolver.file_locks[id].with_read_lock do
+        benchmark "RiiifFile extracted #{path} with #{transformation.to_params}", level: :debug do
+          super
+        end
+      end
+    end
+
+    private
+
+    def logger
+      Hyrax.logger
+    end
+  end
+
+  class RiiifFileResolver
+    include ActiveSupport::Benchmarkable
+
+    # @param [String] id from iiif manifest
+    # @return [Riiif::File]
+    def find(id)
+      path = nil
+      file_locks[id].with_write_lock do
+        path = build_path(id)
+        path = build_path(id, force: true) unless File.exist?(path) # Ensures the file is locally available
+      end
+      RiiifFile.new(path, id: id)
+    end
+
+    # tracks individual file locks
+    # @see RiiifFile
+    # @return [Concurrent::Map<Concurrent::ReadWriteLock>]
+    def file_locks
+      @file_locks ||= Concurrent::Map.new do |k, v|
+        k.compute_if_absent(v) { Concurrent::ReadWriteLock.new }
+      end
+    end
+
+    private
+
+    def build_path(id, force: false)
+      Riiif::Image.cache.fetch("riiif:" + Digest::MD5.hexdigest("path:#{id}"),
+                               expires_in: Riiif::Image.expires_in,
+                               force: force) do
+        load_file(id)
+      end
+    end
+
+    def load_file(id)
+      benchmark "RiiifFileResolver loaded #{id}", level: :debug do
+        fs_id = id.sub(/\A([^\/]*)\/.*/, '\1')
+        file_set = Hyrax.query_service.find_by(id: fs_id)
+        file_metadata = Hyrax.custom_queries.find_original_file(file_set: file_set)
+        file_metadata.file.disk_path.to_s # Stores a local copy in tmpdir
+      end
+    end
+
+    def logger
+      Hyrax.logger
+    end
+  end
+end
+

data/.koppie/config/metadata/collection_resource.yaml

@@ -22,177 +22,19 @@
 #  `rails generate hyrax:collection_resource CollectionResource`
 
 attributes:
-  description:
+  target_audience:
     type: string
-    multiple: true
     form:
       primary: true
-    index_keys:
-      - "description_tesim"
-    predicate: http://purl.org/dc/elements/1.1/description
-  creator:
+      multiple: true
+    predicate: http://hyrax-example.com/target_audience
+  department:
     type: string
-    multiple: true
     form:
-      required: false
-      primary: false
-    index_keys:
-      - "creator_tesim"
-    predicate: http://purl.org/dc/elements/1.1/creator
-  rights_statement:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "rights_statement_tesim"
-    predicate: http://www.europeana.eu/schemas/edm/rights
-  abstract:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "abstract_tesim"
-    predicate: http://purl.org/dc/terms/abstract
-  access_right:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "access_right_tesim"
-    predicate: http://purl.org/dc/terms/accessRights
-  alternative_title:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "alternative_title_tesim"
-    predicate: http://purl.org/dc/terms/alternative
-  based_near:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "based_near_sim"
-      - "based_near_tesim"
-    predicate: http://xmlns.com/foaf/0.1/based_near
-  bibliographic_citation:
-    type: string
-    multiple: true
-    predicate: http://purl.org/dc/terms/bibliographicCitation
-  contributor:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "contributor_tesim"
-    predicate: http://purl.org/dc/elements/1.1/contributor
-  date_created:
-    type: date_time
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "date_created_tesim"
-    predicate: http://purl.org/dc/terms/created
-  identifier:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "identifier_tesim"
-    predicate: http://purl.org/dc/terms/identifier
-  import_url:
-    type: string
-    predicate: http://scholarsphere.psu.edu/ns#importUrl
-  keyword:
-    type: string
-    multiple: true
-    index_keys:
-      - "keyword_sim"
-      - "keyword_tesim"
-    form:
-      primary: false
-    predicate: http://schema.org/keywords
-  publisher:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "publisher_tesim"
-    predicate: http://purl.org/dc/elements/1.1/publisher
-  label:
-    type: string
-    form:
-      primary: false
-    index_keys:
-      - "label_tesim"
-    predicate: info:fedora/fedora-system:def/model#downloadFilename
-  language:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "language_tesim"
-    predicate: http://purl.org/dc/elements/1.1/language
-  license:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "license_tesim"
-    predicate: http://purl.org/dc/terms/license
-  relative_path:
-    type: string
-    predicate: http://scholarsphere.psu.edu/ns#relativePath
-  related_url:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "related_url_tesim"
-    predicate: http://www.w3.org/2000/01/rdf-schema#seeAlso
-  resource_type:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "resource_type_sim"
-      - "resource_type_tesim"
-    predicate: http://purl.org/dc/terms/type
-  rights_notes:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "rights_notes_tesim"
-    predicate: http://purl.org/dc/elements/1.1/rights
-  source:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "source_tesim"
-    predicate: http://purl.org/dc/terms/source
-  subject:
+      primary: true
+    predicate: http://hyrax-example.com/department
+  course:
     type: string
-    multiple: true
-    index_keys:
-      - "subject_sim"
-      - "subject_tesim"
     form:
       primary: false
-    predicate: http://purl.org/dc/elements/1.1/subject
+    predicate: http://hyrax-example.com/course

data/.koppie/config/metadata/sample_metadata.yaml

@@ -0,0 +1,4 @@
+attributes:
+  sample_attribute:
+    type: string
+    predicate: http://hyrax-example.com/sample_attribute