hyrax 4.0.0 → 5.0.0.rc2

data/.dassie/config/metadata/monograph.yaml

@@ -23,6 +23,7 @@
 attributes:
   monograph_title:
     type: string
+    predicate: http://hyrax-example.com/monograph_title
   record_info:
     type: string
     form:
@@ -30,26 +31,33 @@ attributes:
       primary: true
     index_keys:
       - "record_info_tesim"
+    predicate: http://hyrax-example.com/record_info
   place_of_publication:
     type: string
     form:
       required: false
       primary: true
+    predicate: http://hyrax-example.com/place_of_publication
   genre:
     type: string
     form:
       primary: true
+    predicate: http://hyrax-example.com/genre
   series_title:
     type: string
     form:
       primary: false
+    predicate: http://hyrax-example.com/series_title
   target_audience:
     type: string
     form:
       multiple: true
+    predicate: http://hyrax-example.com/target_audience
   table_of_contents:
     type: string
     form:
       multiple: false
+    predicate: http://hyrax-example.com/table_of_contents
   date_of_issuance:
     type: string
+    predicate: http://hyrax-example.com/date_of_issuance

data/.dassie/config/metadata/sample_metadata.yaml

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

data/.dassie/config/redis.yml

@@ -1,9 +1,11 @@
 development:
   host: <%= ENV.fetch('REDIS_HOST', 'localhost') %>
   port: <%= ENV.fetch('REDIS_PORT', 6379) %>
+  password: <%= ENV['REDIS_PASSWORD'] %>
 test:
   host: <%= ENV.fetch('REDIS_HOST', 'localhost') %>
   port: <%= ENV.fetch('REDIS_PORT', 6379) %>
+  password: <%= ENV['REDIS_PASSWORD'] %>
 production:
   host: <%= ENV.fetch('REDIS_HOST', 'localhost') %>
   port: <%= ENV.fetch('REDIS_PORT', 6379) %>

data/.dassie/db/migrate/20230725222727_create_hyrax_counter_metrics.hyrax.rb

@@ -0,0 +1,14 @@
+class CreateHyraxCounterMetrics < ActiveRecord::Migration[5.2]
+  def change
+    create_table :hyrax_counter_metrics do |t|
+      t.string :worktype
+      t.string :resource_type
+      t.integer :work_id
+      t.date :date
+      t.integer :total_item_investigations
+      t.integer :total_item_requests
+
+      t.timestamps
+    end
+  end
+end

data/.dassie/db/migrate/20230803165135_change_work_id_to_string.rb

@@ -0,0 +1,5 @@
+class ChangeWorkIdToString < ActiveRecord::Migration[5.2]
+  def change
+    change_column :hyrax_counter_metrics, :work_id, :string
+  end
+end

data/.dassie/db/migrate/20230808102105_add_indices_to_hyrax_counter_metrics.hyrax.rb

@@ -0,0 +1,8 @@
+class AddIndicesToHyraxCounterMetrics < ActiveRecord::Migration[5.2]
+  def change
+    add_index :hyrax_counter_metrics, :worktype
+    add_index :hyrax_counter_metrics, :resource_type
+    add_index :hyrax_counter_metrics, :work_id
+    add_index :hyrax_counter_metrics, :date
+  end
+end

data/.dassie/db/migrate/20230821153635_add_fields_to_counter_metric.rb

@@ -0,0 +1,8 @@
+class AddFieldsToCounterMetric < ActiveRecord::Migration[5.2]
+  def change
+    add_column :hyrax_counter_metrics, :title, :string
+    add_column :hyrax_counter_metrics, :year_of_publication, :integer, index: true
+    add_column :hyrax_counter_metrics, :publisher, :string, index: true
+    add_column :hyrax_counter_metrics, :author, :string, index: true
+  end
+end

data/.dassie/db/schema.rb

@@ -2,15 +2,15 @@
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
 #
-# This file is the source Rails uses to define your schema when running `rails
-# db:schema:load`. When creating a new database, `rails db:schema:load` tends to
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
 # be faster and is potentially less error prone than running all of your
 # migrations from scratch. Old migrations may fail to apply correctly if those
 # migrations use external dependencies or application code.
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2021_11_30_181150) do
+ActiveRecord::Schema.define(version: 2023_08_21_153635) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -140,6 +140,25 @@ ActiveRecord::Schema.define(version: 2021_11_30_181150) do
     t.index ["machine_id"], name: "index_hyrax_collection_types_on_machine_id", unique: true
   end
 
+  create_table "hyrax_counter_metrics", force: :cascade do |t|
+    t.string "worktype"
+    t.string "resource_type"
+    t.string "work_id"
+    t.date "date"
+    t.integer "total_item_investigations"
+    t.integer "total_item_requests"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.string "title"
+    t.integer "year_of_publication"
+    t.string "publisher"
+    t.string "author"
+    t.index ["date"], name: "index_hyrax_counter_metrics_on_date"
+    t.index ["resource_type"], name: "index_hyrax_counter_metrics_on_resource_type"
+    t.index ["work_id"], name: "index_hyrax_counter_metrics_on_work_id"
+    t.index ["worktype"], name: "index_hyrax_counter_metrics_on_worktype"
+  end
+
   create_table "hyrax_default_administrative_set", force: :cascade do |t|
     t.string "default_admin_set_id", null: false
     t.datetime "created_at", null: false

data/.dockerignore

@@ -7,9 +7,16 @@ Dockerfile
 
 *.rdb
 
+.circleci/*
+.github/*
+
 artifacts/*
 coverage/*
 chart/*
 
 Gemfile.lock
 .dassie/Gemfile.lock
+.koppie/Gemfile.lock
+
+node_modules/*
+yarn.lock

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -13,13 +13,16 @@ Present tense short summary (50 characters or less)
 
 ### Type of change (for release notes)
 
-- [ ] Major Changes (Potentially breaking changes)
-- [ ] New Features
-- [ ] Deprecations
-- [ ] Bug Fixes
-- [ ] Valkyrie Progress
-- [ ] Documentation
-- [ ] Containerization
+Add an appropriate `notes-*` label to the PR (or indicate here) that classifies this change.
+
+Choose from:
+- `notes-major` Major Changes (Potentially breaking changes)
+- `notes-minor` New Features that are backward compatible
+- `notes-deprecation` Deprecations
+- `notes-bugfix` Bug Fixes
+- `notes-valkyrie` Valkyrie Progress
+- `notes-docs` Documentation
+- `notes-container` Containerization related (Docker, Helm, etc)
 
 ### Detailed Description
 

data/.github/release.yml

@@ -3,10 +3,10 @@ changelog:
     - title: Major Changes (Potentially breaking changes)
       labels:
         - notes-major
-    - title: New Features
+    - title: New Features and Non-breaking Changes
       labels:
         - notes-minor
-    - title: Deprecations
+    - title: Deprecation Notices
       labels:
         - notes-deprecation
     - title: Bug Fixes
@@ -21,6 +21,9 @@ changelog:
     - title: Containerization
       labels:
         - notes-container
+    - title: Tests and CI Process
+      labels:
+        - notes-tests
     - title: Other
       labels:
         - "*"

data/.gitignore

@@ -4,7 +4,7 @@
 ruby-version
 ruby-gemset
 .rvmrc
-Gemfile.lock
+Gemfile*.lock
 
 # don't push around data files (for dev envs only)
 fcrepo4-data

data/.koppie/.env

@@ -1,3 +1,7 @@
+APP_NAME=koppie
+BUNDLE_GEMFILE=Gemfile.koppie
+BUNDLE_PATH=/app/bundle
+CH12N_TOOL=fits_servlet
 CHROME_HEADLESS_MODE=false
 DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL=true
 DATABASE_TEST_URL=postgresql://hyrax_user:hyrax_password@postgres/hyrax_test?pool=5
@@ -7,12 +11,17 @@ DB_NAME=koppie
 DB_PASSWORD=hyrax_password
 DB_PORT=5432
 DB_USERNAME=hyrax_user
+FCREPO_URL=http://fedoraAdmin:fedoraAdmin@fcrepo:8080/fcrepo/rest
+FITS_SERVLET_URL=http://fits:8080/fits
 HUB_URL=http://chrome:4444/wd/hub
 HYRAX_DERIVATIVES_PATH=/app/samvera/hyrax-webapp/derivatives/
 HYRAX_ENGINE_PATH=/app/samvera/hyrax-engine
 HYRAX_UPLOAD_PATH=/app/samvera/hyrax-webapp/uploads/
 HYRAX_VALKYRIE=true
 IN_DOCKER=true
+KARMA_BROWSER=remote-chromium
+KARMA_HOSTNAME=app
+MEMCACHED_HOST=memcached
 METADATA_DATABASE_NAME=koppie_metadata_development
 POSTGRES_DB=koppie
 POSTGRES_HOST_AUTH_METHOD=trust
@@ -25,7 +34,7 @@ RAILS_LOG_TO_STDOUT=true
 RAILS_QUEUE=sidekiq
 REDIS_HOST=redis
 REDIS_PASSWORD=sidekickin
-REDIS_URL=redis://noop:sidekickin@redis:6379
+REDIS_URL=redis://:sidekickin@redis:6379
 SEED_KOPPIE=true
 SKIP_SELENIUM=
 SOLR_COLLECTION_NAME=koppie
@@ -34,6 +43,6 @@ SOLR_CORES=koppie
 SOLR_HOST=solr
 SOLR_PORT=8983
 SOLR_URL=http://solr:8983/solr/koppie
-VALKYRIE_SOLR_CORE=koppie
-VALKYRIE_SOLR_HOST=solr
-VALKYRIE_SOLR_PORT=8983
+SOLR_TEST_URL=http://solr:8983/solr/koppie_test
+VALKYRIE_METADATA_ADAPTER=pg_metadata
+VALKYRIE_STORAGE_ADAPTER=versioned_disk_storage

data/.koppie/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+# Attempts to determine if a global gem source has ready been added by another Gemfile
 if @sources.global_rubygems_source == Bundler::SourceList.new.global_rubygems_source
   Bundler.ui.info '[Koppie] Adding global rubygems source.'
   source 'https://rubygems.org'
@@ -10,15 +12,14 @@ gem 'bootsnap', '>= 1.1.0', require: false
 gem 'bootstrap', '~> 4.0'
 gem 'coffee-rails', '~> 4.2'
 gem 'dalli'
-gem 'devise', '4.8.0'
-gem 'devise-guests', '0.8.1'
-gem 'hydra-role-management'
+gem 'devise'
+gem 'devise-guests', '~> 0.8'
 gemspec name: 'hyrax', path: ENV.fetch('HYRAX_ENGINE_PATH', '..')
 gem 'jbuilder', '~> 2.5'
 gem 'jquery-rails'
 gem 'pg', '~> 1.3'
-gem 'puma', '~> 5.5.2'
-gem 'rails', '~> 6.0'
+gem 'puma'
+gem 'rails', '~> 6.1'
 gem 'riiif', '~> 2.1'
 gem 'rsolr', '>= 1.0', '< 3'
 gem 'sass-rails', '~> 6.0'
@@ -41,11 +42,8 @@ group :development do
 end
 
 group :development, :test do
-  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
-  gem "pry-byebug"
-  gem "pry-doc"
-  gem "pry-rails"
-  gem "pry-rescue"
-  gem 'rspec-rails'
-  gem 'solr_wrapper', '>= 0.3'
+  gem 'debug', '>= 1.0.0'
+  gem 'pry-doc'
+  gem 'pry-rails'
+  gem 'pry-rescue'
 end

data/.koppie/Gemfile.koppie

@@ -0,0 +1,2 @@
+# Use dedicated lock files for dassie/koppie to avoid gem mismatches
+eval_gemfile 'Gemfile'

data/.koppie/Rakefile

@@ -4,5 +4,3 @@
 require_relative 'config/application'
 
 Rails.application.load_tasks
-
-require 'solr_wrapper/rake_task' unless Rails.env.production?

data/.koppie/app/models/ability.rb

@@ -1,15 +1,11 @@
 class Ability
   include Hydra::Ability
-  
+
   include Hyrax::Ability
   self.ability_logic += [:everyone_can_create_curation_concerns]
 
   # Define any customized permissions here.
   def custom_permissions
-    if current_user.admin?
-      can [:create, :show, :add_user, :remove_user, :index, :edit, :update, :destroy], Role
-    end
-
     # Limits deleting objects to a the admin user
     #
     # if current_user.admin?

data/.koppie/app/models/user.rb

@@ -1,8 +1,6 @@
 class User < ApplicationRecord
   # Connects this user object to Hydra behaviors.
   include Hydra::User
-  # Connects this user object to Role-management behaviors.
-  include Hydra::RoleManagement::UserRoles
 
   # Connects this user object to Hyrax behaviors.
   include Hyrax::User

data/.koppie/config/application.rb

@@ -6,7 +6,7 @@ require 'rails/all'
 # you've limited to :test, :development, or :production.
 Bundler.require(*Rails.groups)
 
-module NuraxPg
+module Koppie
   class Application < Rails::Application
     # Initialize configuration defaults for originally generated Rails version.
     config.load_defaults 6.0
@@ -15,6 +15,7 @@ module NuraxPg
     # Application configuration can go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded after loading
     # the framework and any gems in your application.
+    config.session_store :cookie_store, key: "_#{ENV.fetch('APP_NAME', 'koppie')}_session"
 
     # use SideKiq by default
     config.active_job.queue_adapter = :sidekiq

data/.koppie/config/arkivo.yml

@@ -0,0 +1,6 @@
+development:
+  url: http://localhost:8888/
+test:
+  url: http://localhost:8888/
+production:
+  url: http://production.host/

data/.koppie/config/blacklight.yml

@@ -1,9 +1,9 @@
 development:
   adapter: solr
-  url: <%= ENV['SOLR_URL'] || "http://127.0.0.1:8983/solr/nurax-pg-blacklight-dev" %>
+  url: <%= ENV['SOLR_DEVELOPMENT_URL'] || ENV['SOLR_URL'] || "http://127.0.0.1:8983/solr/nurax-pg-blacklight-dev" %>
 test: &test
   adapter: solr
-  url: <%= ENV['SOLR_URL'] || "http://127.0.0.1:#{ENV.fetch('SOLR_TEST_PORT', 8985)}/solr/nurax-pg-test" %>
+  url: <%= ENV['SOLR_TEST_URL'] || ENV['SOLR_URL'] || "http://127.0.0.1:#{ENV.fetch('SOLR_TEST_PORT', 8985)}/solr/nurax-pg-test" %>
 production:
   adapter: solr
   url: <%= ENV['SOLR_URL'] || "http://127.0.0.1:8983/solr/nurax-pg" %>

data/.koppie/config/environments/test.rb

@@ -1,5 +1,6 @@
 Rails.application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
+  config.assets.debug = true
 
   # The test environment is used exclusively to run your application's
   # test suite. You never need to work with it otherwise. Remember that

data/.koppie/config/features.yml

@@ -0,0 +1,2 @@
+batch_upload:
+  enabled: "true"

data/.koppie/config/initializers/1_valkyrie.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'faraday/multipart'
 
 # require "shrine/storage/s3"
 # require "valkyrie/storage/shrine"
@@ -24,9 +25,20 @@
 #             :nurax_pg_metadata_adapter)
 Valkyrie::MetadataAdapter.register(
   Valkyrie::Persistence::Postgres::MetadataAdapter.new,
-  :nurax_pg_metadata_adapter
+  :pg_metadata
 )
-Valkyrie.config.metadata_adapter = :nurax_pg_metadata_adapter
+
+Valkyrie::MetadataAdapter.register(
+  Valkyrie::Persistence::Fedora::MetadataAdapter.new(
+    connection: ::Ldp::Client.new(Hyrax.config.fedora_connection_builder.call(
+      ENV.fetch('FCREPO_URL') { "http://localhost:8080/fcrepo/rest" })),
+    base_path: Rails.env,
+    schema: Valkyrie::Persistence::Fedora::PermissiveSchema.new(Hyrax::SimpleSchemaLoader.new.permissive_schema_for_valkrie_adapter),
+    fedora_version: 6
+  ), :fedora_metadata
+)
+
+Valkyrie.config.metadata_adapter = ENV.fetch('VALKYRIE_METADATA_ADAPTER') { :pg_metadata }.to_sym
 
 # shrine_s3_options = {
 #   bucket: ENV.fetch("REPOSITORY_S3_BUCKET") { "nurax_pg#{Rails.env}" },
@@ -46,11 +58,22 @@ Valkyrie.config.metadata_adapter = :nurax_pg_metadata_adapter
 # )
 #
 # Valkyrie.config.storage_adapter = :repository_s3
+
 Valkyrie::StorageAdapter.register(
-  Valkyrie::Storage::Disk.new(base_path: Rails.root.join("storage", "files"),
-                              file_mover: FileUtils.method(:cp)),
-  :disk
+  Valkyrie::Storage::Fedora.new(
+    connection: ::Ldp::Client.new(Hyrax.config.fedora_connection_builder.call(
+      ENV.fetch('FCREPO_URL') { "http://localhost:8080/fcrepo/rest" })),
+    base_path: Rails.env,
+    fedora_version: 6
+  ), :fedora_storage
 )
-Valkyrie.config.storage_adapter  = :disk
+
+Valkyrie::StorageAdapter.register(
+  Valkyrie::Storage::VersionedDisk.new(base_path: Rails.root.join("storage", "files"),
+                                       file_mover: FileUtils.method(:cp)),
+  :versioned_disk_storage
+)
+
+Valkyrie.config.storage_adapter  = ENV.fetch('VALKYRIE_STORAGE_ADAPTER') { :versioned_disk_storage }.to_sym
 
 Valkyrie.config.indexing_adapter = :solr_index

data/.koppie/config/initializers/arkivo_constraint.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Hyrax
+  class ArkivoConstraint
+    def self.matches?(_request)
+      # Add your own logic here to authorize trusted connections to
+      # the API e.g., if your installation of Arkivo runs on a host
+      # with the 10.0.0.3 IP address, you could use:
+      # request.remote_ip == '10.0.0.3'
+      true
+    end
+  end
+end

data/.koppie/config/initializers/hyrax.rb

@@ -7,6 +7,8 @@ Hyrax.config do |config|
 
   config.disable_wings = true # not needed if ENV includes HYRAX_SKIP_WINGS=true
 
+  config.characterization_options = { ch12n_tool: ENV.fetch('CH12N_TOOL', 'fits').to_sym }
+
   # Register roles that are expected by your implementation.
   # @see Hyrax::RoleRegistry for additional details.
   # @note there are magical roles as defined in Hyrax::RoleRegistry::MAGIC_ROLES
@@ -97,14 +99,14 @@ Hyrax.config do |config|
 
   # Hyrax can integrate with Zotero's Arkivo service for automatic deposit
   # of Zotero-managed research items.
-  # config.arkivo_api = false
+  config.arkivo_api = true
 
   # Stream realtime notifications to users in the browser
   # config.realtime_notifications = true
 
   # Location autocomplete uses geonames to search for named regions
   # Username for connecting to geonames
-  # config.geonames_username = ''
+  config.geonames_username = ENV['GEONAMES_USERNAME'] || ''
 
   # Should the acceptance of the licence agreement be active (checkbox), or
   # implied when the save button is pressed? Set to true for active
@@ -247,7 +249,7 @@ Hyrax.config do |config|
   # Identify the model class name that will be used for Collections in your app
   # (i.e. ::Collection for ActiveFedora, Hyrax::PcdmCollection for Valkyrie)
   # config.collection_model = '::Collection'
-  config.collection_model = 'Hyrax::PcdmCollection'
+  # config.collection_model = 'Hyrax::PcdmCollection'
   # Injected via `rails g hyrax:collection_resource CollectionResource`
   config.collection_model = 'CollectionResource'
 
@@ -320,12 +322,16 @@ custom_queries = [Hyrax::CustomQueries::Navigators::CollectionMembers,
                   Hyrax::CustomQueries::Navigators::ParentCollectionsNavigator,
                   Hyrax::CustomQueries::Navigators::ChildFileSetsNavigator,
                   Hyrax::CustomQueries::Navigators::ChildWorksNavigator,
+                  Hyrax::CustomQueries::Navigators::ParentWorkNavigator,
                   Hyrax::CustomQueries::Navigators::FindFiles,
                   Hyrax::CustomQueries::FindAccessControl,
                   Hyrax::CustomQueries::FindCollectionsByType,
                   Hyrax::CustomQueries::FindFileMetadata,
                   Hyrax::CustomQueries::FindIdsByModel,
-                  Hyrax::CustomQueries::FindManyByAlternateIds]
+                  Hyrax::CustomQueries::FindManyByAlternateIds,
+                  Hyrax::CustomQueries::FindModelsByAccess,
+                  Hyrax::CustomQueries::FindCountBy,
+                  Hyrax::CustomQueries::FindByDateRange]
 custom_queries.each do |handler|
   Hyrax.query_service.custom_queries.register_query_handler(handler)
 end

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

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
-ActiveSupport::Reloader.to_prepare do
-  Riiif::Image.file_resolver = Riiif::HttpFileResolver.new
+Rails.application.reloader.to_prepare do
   Riiif::Image.info_service = lambda do |id, _file|
     # id will look like a path to a pcdm:file
     # (e.g. rv042t299%2Ffiles%2F6d71677a-4f80-42f1-ae58-ed1063fd79c7)
     # but we just want the id for the FileSet it's attached to.
 
-    # Capture everything before the first slash
     fs_id = id.sub(/\A([^\/]*)\/.*/, '\1')
     resp = Hyrax::SolrService.get("id:#{fs_id}")
     doc = resp['response']['docs'].first
@@ -14,9 +12,15 @@ ActiveSupport::Reloader.to_prepare do
     { 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|
-    Hyrax::Base.id_to_uri(CGI.unescape(id)).tap do |url|
-      Rails.logger.info "Riiif resolved #{id} to #{url}"
+  if Hyrax.config.use_valkyrie?
+    Riiif::Image.file_resolver = Hyrax::RiiifFileResolver.new
+  else
+    Riiif::Image.file_resolver = Riiif::HttpFileResolver.new
+
+    Riiif::Image.file_resolver.id_to_uri = lambda do |id|
+      Hyrax::Base.id_to_uri(CGI.unescape(id)).tap do |url|
+        Rails.logger.info "Riiif resolved #{id} to #{url}"
+      end
     end
   end
 
@@ -25,5 +29,5 @@ ActiveSupport::Reloader.to_prepare do
   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 = 365.days
+  Riiif::Engine.config.cache_duration = 1.day
 end