hyrax 5.0.0.rc1 → 5.0.0.rc3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.circleci/config.yml +25 -4
- data/.dassie/.env +5 -1
- data/.dassie/Gemfile +27 -42
- data/.dassie/Gemfile.dassie +2 -0
- data/.dassie/app/assets/config/manifest.js +2 -0
- data/.dassie/app/assets/stylesheets/hyrax.scss +1 -0
- data/.dassie/app/listeners/hyrax_listener.rb +81 -0
- data/.dassie/config/environments/test.rb +0 -5
- data/.dassie/config/initializers/hyrax.rb +5 -0
- data/.dassie/config/initializers/publisher.rb +3 -0
- data/.dassie/config/initializers/riiif.rb +82 -11
- data/.dassie/config/metadata/collection_resource.yaml +3 -0
- data/.dassie/config/metadata/monograph.yaml +8 -0
- data/.dassie/config/metadata/sample_metadata.yaml +1 -0
- data/.dassie/config/redis.yml +2 -0
- data/.dassie/db/migrate/20230725222727_create_hyrax_counter_metrics.hyrax.rb +14 -0
- data/.dassie/db/migrate/20230803165135_change_work_id_to_string.rb +5 -0
- data/.dassie/db/migrate/20230808102105_add_indices_to_hyrax_counter_metrics.hyrax.rb +8 -0
- data/.dassie/db/migrate/20230821153635_add_fields_to_counter_metric.rb +8 -0
- data/.dassie/db/schema.rb +20 -1
- data/.dockerignore +2 -1
- data/.gitignore +5 -1
- data/.koppie/.env +10 -4
- data/.koppie/Gemfile +10 -12
- data/.koppie/Gemfile.koppie +2 -0
- data/.koppie/Rakefile +0 -2
- data/.koppie/app/listeners/hyrax_listener.rb +81 -0
- data/.koppie/app/models/ability.rb +1 -5
- data/.koppie/app/models/collection.rb +1 -1
- data/.koppie/app/models/user.rb +0 -2
- data/.koppie/config/analytics.yml +5 -5
- data/.koppie/config/application.rb +2 -1
- data/.koppie/config/arkivo.yml +6 -0
- data/.koppie/config/blacklight.yml +2 -2
- data/.koppie/config/features.yml +2 -0
- data/.koppie/config/initializers/1_valkyrie.rb +29 -6
- data/.koppie/config/initializers/arkivo_constraint.rb +12 -0
- data/.koppie/config/initializers/hyrax.rb +2 -2
- data/.koppie/config/initializers/publisher.rb +3 -0
- data/.koppie/config/initializers/riiif.rb +84 -11
- data/.koppie/config/metadata/collection_resource.yaml +19 -1
- data/.koppie/config/metadata/generic_work.yaml +2 -0
- data/.koppie/config/metadata/monograph.yaml +10 -0
- data/.koppie/config/metadata/sample_metadata.yaml +4 -0
- data/.koppie/config/role_map.yml +3 -25
- data/.koppie/config/routes.rb +1 -2
- data/.koppie/config/solr.yml +1 -1
- data/.koppie/config/valkyrie_index.yml +4 -10
- data/.koppie/config/zotero.yml +6 -0
- data/.koppie/db/migrate/20230725222727_create_hyrax_counter_metrics.hyrax.rb +14 -0
- data/.koppie/db/migrate/20230803165135_change_work_id_to_string.rb +5 -0
- data/.koppie/db/schema.rb +12 -1
- data/CONTAINERS.md +39 -4
- data/Dockerfile +25 -13
- data/Gemfile +8 -24
- data/Gemfile.dassie +2 -0
- data/Gemfile.koppie +2 -0
- data/README.md +2 -1
- data/Rakefile +0 -11
- data/app/actors/hyrax/actors/base_actor.rb +6 -3
- data/app/actors/hyrax/actors/embargo_actor.rb +3 -6
- data/app/actors/hyrax/actors/file_actor.rb +1 -1
- data/app/actors/hyrax/actors/lease_actor.rb +3 -6
- data/app/assets/javascripts/hyrax/batch_select_all.js +1 -1
- data/app/assets/javascripts/hyrax/file_manager/member.es6 +1 -1
- data/app/assets/javascripts/hyrax/save_work/uploaded_files.es6 +10 -2
- data/app/assets/stylesheets/hyrax/_file-listing.scss +0 -2
- data/app/assets/stylesheets/hyrax/_work-show.scss +19 -3
- data/app/assets/stylesheets/hyrax/sidebar.scss +29 -1
- data/app/controllers/concerns/hyrax/collections_controller_behavior.rb +1 -1
- data/app/controllers/concerns/hyrax/embargoes_controller_behavior.rb +7 -1
- data/app/controllers/concerns/hyrax/leases_controller_behavior.rb +7 -1
- data/app/controllers/concerns/hyrax/local_file_downloads_controller_behavior.rb +12 -19
- data/app/controllers/concerns/hyrax/stream_file_downloads_controller_behavior.rb +54 -0
- data/app/controllers/concerns/hyrax/valkyrie_downloads_controller_behavior.rb +52 -18
- data/app/controllers/concerns/hyrax/works_controller_behavior.rb +69 -23
- data/app/controllers/hyrax/admin/admin_sets_controller.rb +2 -2
- data/app/controllers/hyrax/admin/analytics/work_reports_controller.rb +5 -5
- data/app/controllers/hyrax/api/items_controller.rb +2 -3
- data/app/controllers/hyrax/batch_edits_controller.rb +6 -6
- data/app/controllers/hyrax/batch_uploads_controller.rb +5 -1
- data/app/controllers/hyrax/dashboard/collections_controller.rb +6 -3
- data/app/controllers/hyrax/downloads_controller.rb +1 -0
- data/app/controllers/hyrax/file_sets_controller.rb +51 -7
- data/app/controllers/hyrax/my/collections_controller.rb +3 -1
- data/app/controllers/hyrax/single_use_links_viewer_controller.rb +16 -2
- data/app/forms/concerns/hyrax/basic_metadata_form_fields_behavior.rb +39 -0
- data/app/forms/concerns/hyrax/contained_in_works_behavior.rb +24 -0
- data/app/forms/concerns/hyrax/deposit_agreement_behavior.rb +12 -0
- data/app/forms/concerns/hyrax/leaseability_behavior.rb +49 -0
- data/app/forms/concerns/hyrax/permission_behavior.rb +20 -0
- data/app/forms/hyrax/forms/administrative_set_form.rb +1 -5
- data/app/forms/hyrax/forms/collection_form.rb +16 -12
- data/app/forms/hyrax/forms/dashboard/nest_collection_form.rb +0 -34
- data/app/forms/hyrax/forms/file_set_form.rb +7 -2
- data/app/forms/hyrax/forms/pcdm_collection_form.rb +1 -5
- data/app/forms/hyrax/forms/pcdm_object_form.rb +13 -1
- data/app/forms/hyrax/forms/permission_template_form.rb +0 -7
- data/app/forms/hyrax/forms/resource_batch_edit_form.rb +55 -22
- data/app/forms/hyrax/forms/resource_form.rb +31 -114
- data/app/forms/hyrax/forms.rb +52 -0
- data/app/helpers/hyrax/dashboard_helper_behavior.rb +13 -0
- data/app/helpers/hyrax/hyrax_helper_behavior.rb +2 -0
- data/app/indexers/concerns/hyrax/location_indexer.rb +25 -0
- data/app/indexers/{hyrax → concerns/hyrax}/permission_indexer.rb +2 -2
- data/app/indexers/{hyrax → concerns/hyrax}/visibility_indexer.rb +1 -1
- data/app/indexers/hyrax/administrative_set_indexer.rb +5 -17
- data/app/indexers/hyrax/indexers/administrative_set_indexer.rb +25 -0
- data/app/indexers/hyrax/indexers/file_set_indexer.rb +144 -0
- data/app/indexers/hyrax/indexers/pcdm_collection_indexer.rb +27 -0
- data/app/indexers/hyrax/indexers/pcdm_object_indexer.rb +72 -0
- data/app/indexers/hyrax/indexers/resource_indexer.rb +86 -0
- data/app/indexers/hyrax/indexers.rb +54 -0
- data/app/indexers/hyrax/pcdm_collection_indexer.rb +5 -26
- data/app/indexers/hyrax/valkyrie_collection_indexer.rb +6 -4
- data/app/indexers/hyrax/valkyrie_file_set_indexer.rb +5 -141
- data/app/indexers/hyrax/valkyrie_indexer.rb +8 -112
- data/app/indexers/hyrax/valkyrie_work_indexer.rb +5 -63
- data/app/indexers/hyrax/work_indexer.rb +1 -0
- data/app/inputs/controlled_vocabulary_input.rb +1 -1
- data/app/jobs/characterize_job.rb +1 -1
- data/app/jobs/create_work_job.rb +37 -4
- data/app/jobs/valkyrie_characterization_job.rb +9 -0
- data/app/jobs/valkyrie_ingest_job.rb +1 -3
- data/app/models/admin_set.rb +20 -1
- data/app/models/collection.rb +5 -0
- data/app/models/collection_branding_info.rb +2 -9
- data/app/models/concerns/hyrax/ability/admin_set_ability.rb +13 -28
- data/app/models/concerns/hyrax/ability/collection_ability.rb +26 -28
- data/app/models/concerns/hyrax/ability/resource_ability.rb +19 -0
- data/app/models/concerns/hyrax/ability.rb +12 -9
- data/app/models/concerns/hyrax/collection_behavior.rb +12 -12
- data/app/models/concerns/hyrax/solr_document_behavior.rb +33 -6
- data/app/models/concerns/hyrax/work_behavior.rb +4 -0
- data/app/models/featured_work.rb +12 -4
- data/app/models/file_set.rb +5 -0
- data/app/models/hyrax/administrative_set.rb +1 -1
- data/app/models/hyrax/change_set.rb +2 -2
- data/app/models/hyrax/counter_metric.rb +7 -0
- data/app/models/hyrax/file_metadata.rb +37 -9
- data/app/models/hyrax/file_set.rb +77 -24
- data/app/models/hyrax/group.rb +9 -38
- data/app/models/hyrax/group_behavior.rb +58 -0
- data/app/models/hyrax/model_registry.rb +111 -0
- data/app/models/hyrax/orcid_validator.rb +0 -6
- data/app/models/hyrax/pcdm_collection.rb +1 -7
- data/app/models/hyrax/resource.rb +66 -8
- data/app/models/hyrax/statistic.rb +1 -1
- data/app/models/hyrax/work.rb +3 -12
- data/app/presenters/hyrax/collapsable_section_presenter.rb +7 -3
- data/app/presenters/hyrax/collection_presenter.rb +0 -17
- data/app/presenters/hyrax/embargo_presenter.rb +4 -0
- data/app/presenters/hyrax/file_set_presenter.rb +8 -6
- data/app/presenters/hyrax/lease_presenter.rb +4 -0
- data/app/presenters/hyrax/menu_presenter.rb +14 -2
- data/app/presenters/hyrax/pcdm_member_presenter_factory.rb +7 -5
- data/app/presenters/hyrax/version_list_presenter.rb +25 -14
- data/app/presenters/hyrax/version_presenter.rb +19 -4
- data/app/search_builders/hyrax/admin_set_search_builder.rb +1 -1
- data/app/search_builders/hyrax/catalog_search_builder.rb +2 -2
- data/app/search_builders/hyrax/dashboard/collections_search_builder.rb +5 -3
- data/app/search_builders/hyrax/exposed_models_relation.rb +1 -1
- data/app/search_builders/hyrax/file_set_search_builder.rb +1 -1
- data/app/search_builders/hyrax/filter_by_type.rb +3 -2
- data/app/search_builders/hyrax/member_with_files_search_builder.rb +1 -1
- data/app/search_builders/hyrax/my/collections_search_builder.rb +2 -2
- data/app/search_builders/hyrax/my/find_works_search_builder.rb +8 -3
- data/app/services/hyrax/access_control_list.rb +21 -4
- data/app/services/hyrax/action/create_valkyrie_work.rb +80 -0
- data/app/services/hyrax/admin_set_create_service.rb +7 -20
- data/app/services/hyrax/admin_set_service.rb +2 -2
- data/app/services/hyrax/characterization/valkyrie_characterization_service.rb +5 -0
- data/app/services/hyrax/collections/collection_member_search_service.rb +2 -0
- data/app/services/hyrax/collections/collection_member_service.rb +1 -1
- data/app/services/hyrax/collections/permissions_service.rb +27 -9
- data/app/services/hyrax/custom_queries/find_collections_by_type.rb +1 -1
- data/app/services/hyrax/custom_queries/find_file_metadata.rb +1 -1
- data/app/services/hyrax/custom_queries/navigators/find_files.rb +1 -1
- data/app/services/hyrax/custom_queries/navigators/parent_work_navigator.rb +1 -1
- data/app/services/hyrax/edit_permissions_service.rb +1 -1
- data/app/services/hyrax/embargo_manager.rb +44 -17
- data/app/services/hyrax/embargo_service.rb +12 -10
- data/app/services/hyrax/file_set_derivatives_service.rb +11 -11
- data/app/services/hyrax/file_set_file_service.rb +21 -10
- data/app/services/hyrax/fixity_check_failure_service.rb +1 -1
- data/app/services/hyrax/form_factory.rb +1 -1
- data/app/services/hyrax/identifier/dispatcher.rb +9 -2
- data/app/services/hyrax/lease_manager.rb +39 -16
- data/app/services/hyrax/lease_service.rb +12 -6
- data/app/services/hyrax/listeners/acl_index_listener.rb +1 -1
- data/app/services/hyrax/listeners/active_fedora_acl_index_listener.rb +1 -1
- data/app/services/hyrax/listeners/file_metadata_listener.rb +14 -6
- data/app/services/hyrax/listeners/member_cleanup_listener.rb +12 -24
- data/app/services/hyrax/listeners/metadata_index_listener.rb +11 -0
- data/app/services/hyrax/listeners/object_lifecycle_listener.rb +5 -1
- data/app/services/hyrax/listeners/trophy_cleanup_listener.rb +2 -1
- data/app/services/hyrax/listeners/workflow_listener.rb +13 -0
- data/app/services/hyrax/listeners.rb +2 -1
- data/app/services/hyrax/location_service.rb +3 -0
- data/app/services/hyrax/lock_manager.rb +1 -2
- data/app/services/hyrax/multiple_membership_checker.rb +1 -1
- data/app/services/hyrax/simple_schema_loader.rb +32 -1
- data/app/services/hyrax/solr_service.rb +19 -5
- data/app/services/hyrax/statistics/collections/over_time.rb +1 -1
- data/app/services/hyrax/statistics/query_service.rb +6 -0
- data/app/services/hyrax/valkyrie_persist_derivatives.rb +12 -5
- data/app/services/hyrax/valkyrie_upload.rb +13 -27
- data/app/services/hyrax/versioning_service.rb +29 -15
- data/app/services/hyrax/work_uploads_handler.rb +6 -5
- data/app/validators/hyrax/collection_membership_validator.rb +1 -1
- data/app/views/_user_util_links.html.erb +1 -1
- data/app/views/catalog/_search_form.html.erb +1 -1
- data/app/views/collections/edit_fields/_based_near.html.erb +11 -7
- data/app/views/hyrax/admin/admin_sets/_form_participants.html.erb +67 -67
- data/app/views/hyrax/admin/admin_sets/edit.html.erb +1 -1
- data/app/views/hyrax/admin/collection_types/_form_participants.html.erb +3 -1
- data/app/views/hyrax/admin/collection_types/index.html.erb +1 -1
- data/app/views/hyrax/base/_attribute_rows.html.erb +1 -0
- data/app/views/hyrax/base/_base_form_files_prepend.html.erb +4 -0
- data/app/views/hyrax/base/_file_manager_resource_form.html.erb +1 -1
- data/app/views/hyrax/base/_form_files.html.erb +65 -64
- data/app/views/hyrax/base/_form_visibility_component.html.erb +4 -4
- data/app/views/hyrax/base/_show_actions.html.erb +1 -1
- data/app/views/hyrax/base/_workflow_actions.html.erb +25 -23
- data/app/views/hyrax/base/show.html.erb +2 -3
- data/app/views/hyrax/base/show.json.jbuilder +2 -1
- data/app/views/hyrax/collections/_show_document_list_row.html.erb +1 -1
- data/app/views/hyrax/collections/show.html.erb +7 -9
- data/app/views/hyrax/dashboard/_sidebar.html.erb +4 -3
- data/app/views/hyrax/dashboard/collections/_form_share_table.html.erb +2 -2
- data/app/views/hyrax/dashboard/collections/_list_collections.html.erb +1 -1
- data/app/views/hyrax/dashboard/collections/_show_document_list_row.html.erb +1 -1
- data/app/views/hyrax/dashboard/collections/_sort_and_per_page.html.erb +3 -3
- data/app/views/hyrax/file_sets/_versioning.html.erb +5 -5
- data/app/views/hyrax/file_sets/media_display/_audio.html.erb +5 -5
- data/app/views/hyrax/file_sets/media_display/_default.html.erb +1 -1
- data/app/views/hyrax/file_sets/media_display/_video.html.erb +3 -3
- data/app/views/hyrax/my/_search_form.html.erb +1 -1
- data/app/views/hyrax/my/facet.html.erb +1 -1
- data/app/views/hyrax/notifications/_notifications.html.erb +1 -1
- data/app/views/hyrax/users/_vitals.html.erb +1 -1
- data/app/views/layouts/_head_tag_content.html.erb +1 -0
- data/app/views/shared/_footer.html.erb +1 -1
- data/bin/dev-entrypoint.sh +13 -0
- data/chart/hyrax/Chart.yaml +5 -5
- data/chart/hyrax/templates/_helpers.tpl +8 -0
- data/chart/hyrax/templates/configmap-env.yaml +1 -1
- data/chart/hyrax/values.yaml +12 -1
- data/config/initializers/file_length_patch.rb +10 -0
- data/config/initializers/listeners.rb +1 -1
- data/config/locales/hyrax.de.yml +5 -0
- data/config/locales/hyrax.en.yml +10 -0
- data/config/locales/hyrax.es.yml +5 -0
- data/config/locales/hyrax.fr.yml +5 -0
- data/config/locales/hyrax.it.yml +5 -0
- data/config/locales/hyrax.pt-BR.yml +5 -0
- data/config/locales/hyrax.zh.yml +5 -0
- data/config/metadata/basic_metadata.yaml +53 -0
- data/config/metadata/core_metadata.yaml +6 -0
- data/config/metadata/file_set_metadata.yaml +21 -0
- data/config/metadata/hyrax_internal_metadata.yaml +57 -0
- data/docker-compose-koppie.yml +26 -25
- data/docker-compose-sirenia.yml +202 -0
- data/docker-compose.yml +27 -24
- data/documentation/developing-your-hyrax-based-app.md +77 -60
- data/hyrax.gemspec +18 -12
- data/karma.conf.js +1 -1
- data/lib/generators/hyrax/collection_resource/templates/collection_indexer.rb.erb +1 -1
- data/lib/generators/hyrax/collection_resource/templates/collection_metadata.yaml +2 -0
- data/lib/generators/hyrax/config_generator.rb +12 -0
- data/lib/generators/hyrax/install_generator.rb +37 -7
- data/lib/generators/hyrax/listeners_generator.rb +18 -0
- data/lib/generators/hyrax/models_generator.rb +1 -10
- data/lib/generators/hyrax/riiif_generator.rb +6 -4
- data/lib/generators/hyrax/templates/.env +9 -0
- data/lib/generators/hyrax/templates/.lando.yml +50 -0
- data/lib/generators/hyrax/templates/app/listeners/hyrax_listener.rb +81 -0
- data/lib/generators/hyrax/templates/app/models/file_set.rb +1 -2
- data/lib/generators/hyrax/templates/config/initializers/1_valkyrie.rb +102 -0
- data/lib/generators/hyrax/templates/config/initializers/file_services.rb +6 -0
- data/lib/generators/hyrax/templates/config/initializers/hyrax.rb +41 -5
- data/lib/generators/hyrax/templates/config/initializers/publisher.rb +3 -0
- data/lib/generators/hyrax/templates/config/initializers/riiif.rb +90 -19
- data/lib/generators/hyrax/templates/config/locales/hyrax.de.yml +1 -1
- data/lib/generators/hyrax/templates/config/locales/hyrax.en.yml +1 -1
- data/lib/generators/hyrax/templates/config/locales/hyrax.es.yml +1 -1
- data/lib/generators/hyrax/templates/config/locales/hyrax.fr.yml +1 -1
- data/lib/generators/hyrax/templates/config/locales/hyrax.it.yml +1 -1
- data/lib/generators/hyrax/templates/config/locales/hyrax.pt-BR.yml +1 -1
- data/lib/generators/hyrax/templates/config/locales/hyrax.zh.yml +1 -1
- data/lib/generators/hyrax/templates/config/redis.yml +3 -6
- data/lib/generators/hyrax/templates/config/valkyrie_index.yml +4 -9
- data/lib/generators/hyrax/templates/db/migrate/20230725222727_create_hyrax_counter_metrics.rb.erb +14 -0
- data/lib/generators/hyrax/templates/db/migrate/20230803165135_change_work_id_to_string.rb.erb +5 -0
- data/lib/generators/hyrax/templates/db/migrate/20230808102105_add_indices_to_hyrax_counter_metrics.rb.erb +8 -0
- data/lib/generators/hyrax/templates/db/migrate/20230821153635_add_fields_to_counter_metric.rb.erb +8 -0
- data/lib/generators/hyrax/templates/db/seeds.rb +1 -1
- data/lib/generators/hyrax/work_resource/templates/form.rb.erb +1 -1
- data/lib/generators/hyrax/work_resource/templates/indexer.rb.erb +1 -1
- data/lib/generators/hyrax/work_resource/templates/metadata.yaml +2 -0
- data/lib/hyrax/configuration.rb +241 -55
- data/lib/hyrax/controlled_vocabularies/location.rb +7 -1
- data/lib/hyrax/engine.rb +0 -1
- data/lib/hyrax/form_fields.rb +6 -0
- data/lib/hyrax/indexer.rb +1 -1
- data/lib/hyrax/publisher.rb +9 -2
- data/lib/hyrax/redis_event_store.rb +7 -8
- data/lib/hyrax/resource_name.rb +4 -0
- data/lib/hyrax/resource_sync/change_list_writer.rb +1 -1
- data/lib/hyrax/resource_sync/resource_list_writer.rb +1 -1
- data/lib/hyrax/specs/capybara.rb +26 -42
- data/lib/hyrax/specs/shared_specs/hydra_works.rb +112 -27
- data/lib/hyrax/specs/shared_specs/indexers.rb +25 -7
- data/lib/hyrax/transactions/admin_set_destroy.rb +2 -1
- data/lib/hyrax/transactions/collection_destroy.rb +3 -2
- data/lib/hyrax/transactions/container.rb +47 -0
- data/lib/hyrax/transactions/file_metadata_destroy.rb +20 -0
- data/lib/hyrax/transactions/file_set_destroy.rb +3 -1
- data/lib/hyrax/transactions/file_set_update.rb +21 -0
- data/lib/hyrax/transactions/steps/add_to_parent.rb +2 -1
- data/lib/hyrax/transactions/steps/check_for_default_admin_set.rb +32 -0
- data/lib/hyrax/transactions/steps/check_for_empty_admin_set.rb +1 -1
- data/lib/hyrax/transactions/steps/delete_all_file_metadata.rb +46 -0
- data/lib/hyrax/transactions/steps/delete_all_file_sets.rb +46 -0
- data/lib/hyrax/transactions/steps/file_metadata_delete.rb +40 -0
- data/lib/hyrax/transactions/steps/remove_from_membership.rb +45 -0
- data/lib/hyrax/transactions/steps/save.rb +2 -1
- data/lib/hyrax/transactions/steps/set_user_as_creator.rb +1 -1
- data/lib/hyrax/transactions/steps/update_work_members.rb +2 -0
- data/lib/hyrax/transactions/work_destroy.rb +3 -2
- data/lib/hyrax/version.rb +1 -1
- data/lib/hyrax.rb +1 -0
- data/lib/tasks/collection_type_global_id.rake +9 -4
- data/lib/tasks/embargo_lease.rake +2 -0
- data/lib/valkyrie/indexing/solr/indexing_adapter.rb +22 -6
- data/lib/wings/active_fedora_converter/default_work.rb +4 -5
- data/lib/wings/active_fedora_converter/file_metadata_node.rb +1 -1
- data/lib/wings/active_fedora_converter.rb +6 -0
- data/lib/wings/attribute_transformer.rb +24 -17
- data/lib/wings/model_registry.rb +8 -0
- data/lib/wings/model_transformer.rb +19 -10
- data/lib/wings/orm_converter.rb +27 -18
- data/lib/wings/services/custom_queries/find_ids_by_model.rb +2 -2
- data/lib/wings/setup.rb +2 -2
- data/lib/wings/valkyrie/query_service.rb +5 -2
- data/lib/wings/valkyrie/storage.rb +8 -90
- data/lib/wings.rb +8 -0
- data/spec/factories/access_control.rb +12 -0
- data/spec/factories/admin_sets.rb +32 -0
- data/spec/factories/admin_sets_lw.rb +222 -0
- data/spec/factories/administrative_sets.rb +79 -0
- data/spec/factories/api_items.rb +92 -0
- data/spec/factories/collection_branding_infos.rb +12 -0
- data/spec/factories/collection_type_participants.rb +9 -0
- data/spec/factories/collection_types.rb +139 -0
- data/spec/factories/collections.rb +282 -0
- data/spec/factories/collections_factory.rb +107 -0
- data/spec/factories/content_blocks.rb +5 -0
- data/spec/factories/counter_metrics.rb +12 -0
- data/spec/factories/featured_works.rb +5 -0
- data/spec/factories/file_sets.rb +45 -0
- data/spec/factories/generic_works.rb +200 -0
- data/spec/factories/hyrax_collection.rb +92 -0
- data/spec/factories/hyrax_default_admin_set.rb +7 -0
- data/spec/factories/hyrax_embargo.rb +18 -0
- data/spec/factories/hyrax_file_metadata.rb +92 -0
- data/spec/factories/hyrax_file_set.rb +129 -0
- data/spec/factories/hyrax_lease.rb +18 -0
- data/spec/factories/hyrax_resource.rb +15 -0
- data/spec/factories/hyrax_work.rb +221 -0
- data/spec/factories/object_id.rb +7 -0
- data/spec/factories/operations.rb +22 -0
- data/spec/factories/permission.rb +7 -0
- data/spec/factories/permission_template_accesses.rb +17 -0
- data/spec/factories/permission_templates.rb +111 -0
- data/spec/factories/proxy_deposit_requests.rb +7 -0
- data/spec/factories/single_use_links.rb +14 -0
- data/spec/factories/sipity_entities.rb +17 -0
- data/spec/factories/uploaded_files.rb +11 -0
- data/spec/factories/users.rb +52 -0
- data/spec/factories/workflow_actions.rb +7 -0
- data/spec/factories/workflow_states.rb +7 -0
- data/spec/factories/workflows.rb +7 -0
- data/spec/support/book_resource.rb +36 -0
- data/spec/support/can_can_overrides.rb +43 -0
- data/spec/support/clean_solr.rb +7 -0
- data/spec/support/controller_level_helpers.rb +27 -0
- data/spec/support/factory_helpers.rb +94 -0
- data/spec/support/fakes/fake_actor.rb +22 -0
- data/spec/support/fakes/fake_authority.rb +14 -0
- data/spec/support/fakes/fake_search_builder_scope.rb +44 -0
- data/spec/support/fakes/indexing_adapter.rb +17 -0
- data/spec/support/fakes/test_hydra_group_service.rb +55 -0
- data/spec/support/features/batch_edit_actions.rb +37 -0
- data/spec/support/features/session_helpers.rb +15 -0
- data/spec/support/features/workflow.rb +10 -0
- data/spec/support/features.rb +11 -0
- data/spec/support/form_with_validations.rb +15 -0
- data/spec/support/input_support.rb +12 -0
- data/spec/support/logging_formatter.rb +67 -0
- data/spec/support/matchers/api_responses.rb +27 -0
- data/spec/support/matchers/collection_type_property_matchers.rb +30 -0
- data/spec/support/matchers/embargo.rb +9 -0
- data/spec/support/matchers/lease.rb +9 -0
- data/spec/support/matchers/match_valkyrie_ids_with_af_ids.rb +12 -0
- data/spec/support/matchers/pcdm_matchers.rb +34 -0
- data/spec/support/matchers/permission.rb +31 -0
- data/spec/support/matchers/response_matchers.rb +8 -0
- data/spec/support/optional_example.rb +17 -0
- data/spec/support/rake.rb +42 -0
- data/spec/support/selectors.rb +112 -0
- data/spec/support/shared_examples_for_collection_presenter.rb +44 -0
- data/spec/support/simple_work.rb +28 -0
- data/spec/support/spec_statistic.rb +24 -0
- data/spec/support/speedup.rb +7 -0
- data/spec/support/statistic_helper.rb +10 -0
- data/spec/support/valkyrie_indexing.rb +2 -0
- data/spec/support/wings_models.rb +9 -0
- data/tasks/hyrax_dev.rake +2 -33
- data/template.rb +1 -3
- metadata +184 -84
- data/.engine_cart.yml +0 -3
- data/app/indexers/hyrax/resource_indexer.rb +0 -15
- data/app/services/hyrax/characterization/model_wrapper.rb +0 -0
- data/app/services/hyrax/custom_queries/find_by_collection_type.rb +0 -0
- data/app/services/hyrax/query_service.rb +0 -0
- data/app/views/hyrax/users/_user_util_links_extra.html.erb +0 -0
- data/lib/hyrax/specs/disable_animations_in_test_environment.rb +0 -53
- data/lib/hyrax/specs/shared_specs/valkyrie_storage_versions.rb +0 -9
- /data/app/indexers/{hyrax → concerns/hyrax}/thumbnail_indexer.rb +0 -0
@@ -0,0 +1,202 @@
|
|
1
|
+
# Requires Docker Compose v2
|
2
|
+
name: sirenia
|
3
|
+
services:
|
4
|
+
app: &app
|
5
|
+
build:
|
6
|
+
context: .
|
7
|
+
target: hyrax-engine-dev
|
8
|
+
args:
|
9
|
+
- EXTRA_APK_PACKAGES=git less
|
10
|
+
- APP_PATH=.koppie
|
11
|
+
image: samvera/koppie
|
12
|
+
entrypoint: dev-entrypoint.sh
|
13
|
+
command: sh -c 'bundle exec puma -v -b tcp://0.0.0.0:3000'
|
14
|
+
stdin_open: true
|
15
|
+
tty: true
|
16
|
+
user: root
|
17
|
+
env_file:
|
18
|
+
- .koppie/.env
|
19
|
+
environment:
|
20
|
+
- APP_NAME=sirenia
|
21
|
+
- RAILS_ROOT=/app/samvera/hyrax-webapp
|
22
|
+
- VALKYRIE_METADATA_ADAPTER=fedora_metadata
|
23
|
+
- VALKYRIE_STORAGE_ADAPTER=fedora_storage
|
24
|
+
depends_on:
|
25
|
+
- chrome
|
26
|
+
- db_migrate
|
27
|
+
- memcached
|
28
|
+
- postgres
|
29
|
+
- redis
|
30
|
+
- solr
|
31
|
+
ports:
|
32
|
+
- 3002:3000
|
33
|
+
- 9878:9876
|
34
|
+
- 1050:1048
|
35
|
+
volumes:
|
36
|
+
- ./bin:/app/samvera
|
37
|
+
- .koppie:/app/samvera/hyrax-webapp
|
38
|
+
- .:/app/samvera/hyrax-engine
|
39
|
+
- bundle:/app/bundle
|
40
|
+
- hyrax-storage:/app/samvera/hyrax-webapp/storage
|
41
|
+
- hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
|
42
|
+
- hyrax-uploads:/app/samvera/hyrax-webapp/uploads
|
43
|
+
- rails-public:/app/samvera/hyrax-webapp/public
|
44
|
+
- rails-tmp:/app/samvera/hyrax-webapp/tmp
|
45
|
+
networks:
|
46
|
+
- sirenia
|
47
|
+
|
48
|
+
sidekiq:
|
49
|
+
image: samvera/koppie
|
50
|
+
entrypoint: dev-entrypoint.sh
|
51
|
+
command: sh -c 'bundle exec sidekiq'
|
52
|
+
user: root
|
53
|
+
env_file:
|
54
|
+
- .koppie/.env
|
55
|
+
environment:
|
56
|
+
- APP_NAME=sirenia
|
57
|
+
- VALKYRIE_METADATA_ADAPTER=fedora_metadata
|
58
|
+
- VALKYRIE_STORAGE_ADAPTER=fedora_storage
|
59
|
+
depends_on:
|
60
|
+
- db_migrate
|
61
|
+
- memcached
|
62
|
+
- postgres
|
63
|
+
- redis
|
64
|
+
- solr
|
65
|
+
volumes:
|
66
|
+
- ./bin:/app/samvera
|
67
|
+
- .koppie:/app/samvera/hyrax-webapp
|
68
|
+
- .:/app/samvera/hyrax-engine
|
69
|
+
- bundle:/app/bundle
|
70
|
+
- hyrax-storage:/app/samvera/hyrax-webapp/storage
|
71
|
+
- hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
|
72
|
+
- hyrax-uploads:/app/samvera/hyrax-webapp/uploads
|
73
|
+
- rails-public:/app/samvera/hyrax-webapp/public
|
74
|
+
- rails-tmp:/app/samvera/hyrax-webapp/tmp
|
75
|
+
networks:
|
76
|
+
- sirenia
|
77
|
+
|
78
|
+
db_migrate:
|
79
|
+
image: samvera/koppie
|
80
|
+
user: root
|
81
|
+
env_file:
|
82
|
+
- .koppie/.env
|
83
|
+
environment:
|
84
|
+
- APP_NAME=sirenia
|
85
|
+
- VALKYRIE_METADATA_ADAPTER=fedora_metadata
|
86
|
+
- VALKYRIE_STORAGE_ADAPTER=fedora_storage
|
87
|
+
entrypoint: dev-entrypoint.sh
|
88
|
+
command: db-migrate-seed.sh
|
89
|
+
depends_on:
|
90
|
+
- postgres
|
91
|
+
- solr
|
92
|
+
volumes:
|
93
|
+
- ./bin:/app/samvera
|
94
|
+
- .koppie:/app/samvera/hyrax-webapp
|
95
|
+
- .:/app/samvera/hyrax-engine
|
96
|
+
- bundle:/app/bundle
|
97
|
+
- rails-public:/app/samvera/hyrax-webapp/public
|
98
|
+
- rails-tmp:/app/samvera/hyrax-webapp/tmp
|
99
|
+
networks:
|
100
|
+
- sirenia
|
101
|
+
|
102
|
+
chrome:
|
103
|
+
image: seleniarm/standalone-chromium:114.0
|
104
|
+
environment:
|
105
|
+
- START_XVFB=false
|
106
|
+
logging:
|
107
|
+
driver: none
|
108
|
+
volumes:
|
109
|
+
- /dev/shm:/dev/shm
|
110
|
+
shm_size: 2G
|
111
|
+
ports:
|
112
|
+
- "4447:4444"
|
113
|
+
- "5962:5900"
|
114
|
+
networks:
|
115
|
+
- sirenia
|
116
|
+
|
117
|
+
postgres:
|
118
|
+
image: postgres:15
|
119
|
+
env_file:
|
120
|
+
- .koppie/.env
|
121
|
+
ports:
|
122
|
+
- "5434:5432"
|
123
|
+
volumes:
|
124
|
+
- db:/var/lib/postgresql/data
|
125
|
+
networks:
|
126
|
+
- sirenia
|
127
|
+
|
128
|
+
fcrepo:
|
129
|
+
image: fcrepo/fcrepo:6.4.0
|
130
|
+
environment:
|
131
|
+
- >-
|
132
|
+
CATALINA_OPTS=-Dfcrepo.home=/fcrepo-home -Djava.awt.headless=true -Dfile.encoding=UTF-8
|
133
|
+
-server -Xms512m -Xmx1024m -XX:NewSize=256m -XX:MaxNewSize=256m -XX:PermSize=256m
|
134
|
+
-XX:MaxPermSize=256m -XX:+DisableExplicitGC -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true
|
135
|
+
- JAVA_OPTS=-Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true
|
136
|
+
volumes:
|
137
|
+
- fcrepo:/fcrepo-home
|
138
|
+
ports:
|
139
|
+
- 8081:8080
|
140
|
+
networks:
|
141
|
+
- sirenia
|
142
|
+
|
143
|
+
fits:
|
144
|
+
image: ghcr.io/samvera/fitsservlet:1.6.0
|
145
|
+
ports:
|
146
|
+
- 9082:8080
|
147
|
+
networks:
|
148
|
+
- sirenia
|
149
|
+
|
150
|
+
memcached:
|
151
|
+
image: bitnami/memcached
|
152
|
+
ports:
|
153
|
+
- '11213:11211'
|
154
|
+
networks:
|
155
|
+
- sirenia
|
156
|
+
|
157
|
+
redis:
|
158
|
+
image: bitnami/redis:6.2
|
159
|
+
env_file:
|
160
|
+
- .koppie/.env
|
161
|
+
volumes:
|
162
|
+
- redis:/bitnami/redis/data
|
163
|
+
networks:
|
164
|
+
- sirenia
|
165
|
+
|
166
|
+
solr:
|
167
|
+
image: solr:8.11
|
168
|
+
ports:
|
169
|
+
- 8985:8983
|
170
|
+
command:
|
171
|
+
- sh
|
172
|
+
- "-c"
|
173
|
+
- "precreate-core hydra-test /opt/solr/server/configsets/hyraxconf; solr-precreate koppie /opt/solr/server/configsets/hyraxconf"
|
174
|
+
volumes:
|
175
|
+
- solr_home:/var/solr/data:cached
|
176
|
+
- .koppie/solr/conf:/opt/solr/server/configsets/hyraxconf
|
177
|
+
ulimits:
|
178
|
+
nofile:
|
179
|
+
soft: 65536
|
180
|
+
hard: 524288
|
181
|
+
networks:
|
182
|
+
- sirenia
|
183
|
+
|
184
|
+
volumes:
|
185
|
+
bundle:
|
186
|
+
db:
|
187
|
+
fcrepo:
|
188
|
+
hyrax-storage:
|
189
|
+
hyrax-derivatives:
|
190
|
+
hyrax-uploads:
|
191
|
+
rails-public:
|
192
|
+
rails-tmp:
|
193
|
+
redis:
|
194
|
+
sidekiq-public:
|
195
|
+
sidekiq-tmp:
|
196
|
+
solr_home:
|
197
|
+
|
198
|
+
networks:
|
199
|
+
sirenia:
|
200
|
+
driver: bridge
|
201
|
+
driver_opts:
|
202
|
+
com.docker.network.bridge.name: br-sirenia
|
data/docker-compose.yml
CHANGED
@@ -6,9 +6,11 @@ services:
|
|
6
6
|
context: .
|
7
7
|
target: hyrax-engine-dev
|
8
8
|
args:
|
9
|
-
- EXTRA_APK_PACKAGES=git less
|
10
|
-
|
11
|
-
|
9
|
+
- EXTRA_APK_PACKAGES=git less
|
10
|
+
- BUNDLE_GEMFILE=Gemfile.dassie
|
11
|
+
image: samvera/dassie
|
12
|
+
entrypoint: dev-entrypoint.sh
|
13
|
+
command: sh -c 'bundle exec puma -v -b tcp://0.0.0.0:3000'
|
12
14
|
stdin_open: true
|
13
15
|
tty: true
|
14
16
|
user: root
|
@@ -28,8 +30,10 @@ services:
|
|
28
30
|
- 3000:3000
|
29
31
|
- 9876:9876
|
30
32
|
volumes:
|
33
|
+
- ./bin:/app/samvera
|
31
34
|
- .dassie:/app/samvera/hyrax-webapp
|
32
35
|
- .:/app/samvera/hyrax-engine
|
36
|
+
- bundle:/app/bundle
|
33
37
|
- hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
|
34
38
|
- hyrax-uploads:/app/samvera/hyrax-webapp/uploads
|
35
39
|
- rails-public:/app/samvera/hyrax-webapp/public
|
@@ -38,11 +42,9 @@ services:
|
|
38
42
|
- hyrax
|
39
43
|
|
40
44
|
sidekiq:
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
image: ghcr.io/samvera/dassie-worker
|
45
|
-
command: sh -c 'bundle && bundle exec sidekiq'
|
45
|
+
image: samvera/dassie
|
46
|
+
entrypoint: dev-entrypoint.sh
|
47
|
+
command: sh -c 'bundle exec sidekiq'
|
46
48
|
user: root
|
47
49
|
env_file:
|
48
50
|
- .dassie/.env
|
@@ -54,31 +56,31 @@ services:
|
|
54
56
|
- redis
|
55
57
|
- solr
|
56
58
|
volumes:
|
59
|
+
- ./bin:/app/samvera
|
57
60
|
- .dassie:/app/samvera/hyrax-webapp
|
58
61
|
- .:/app/samvera/hyrax-engine
|
62
|
+
- bundle:/app/bundle
|
59
63
|
- hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
|
60
64
|
- hyrax-uploads:/app/samvera/hyrax-webapp/uploads
|
61
|
-
-
|
62
|
-
-
|
65
|
+
- rails-public:/app/samvera/hyrax-webapp/public
|
66
|
+
- rails-tmp:/app/samvera/hyrax-webapp/tmp
|
63
67
|
networks:
|
64
68
|
- hyrax
|
65
69
|
|
66
70
|
db_migrate:
|
67
|
-
|
68
|
-
context: .
|
69
|
-
target: hyrax-engine-dev
|
70
|
-
args:
|
71
|
-
- EXTRA_APK_PACKAGES=git less
|
72
|
-
image: ghcr.io/samvera/dassie
|
71
|
+
image: samvera/dassie
|
73
72
|
user: root
|
74
73
|
env_file:
|
75
74
|
- .dassie/.env
|
76
|
-
|
75
|
+
entrypoint: dev-entrypoint.sh
|
76
|
+
command: db-migrate-seed.sh
|
77
77
|
depends_on:
|
78
78
|
- postgres
|
79
79
|
volumes:
|
80
|
+
- ./bin:/app/samvera
|
80
81
|
- .dassie:/app/samvera/hyrax-webapp
|
81
82
|
- .:/app/samvera/hyrax-engine
|
83
|
+
- bundle:/app/bundle
|
82
84
|
- rails-public:/app/samvera/hyrax-webapp/public
|
83
85
|
- rails-tmp:/app/samvera/hyrax-webapp/tmp
|
84
86
|
networks:
|
@@ -100,7 +102,7 @@ services:
|
|
100
102
|
- hyrax
|
101
103
|
|
102
104
|
postgres:
|
103
|
-
image: postgres:
|
105
|
+
image: postgres:15
|
104
106
|
environment:
|
105
107
|
- POSTGRES_USER=hyrax_user
|
106
108
|
- POSTGRES_PASSWORD=hyrax_password
|
@@ -123,7 +125,7 @@ services:
|
|
123
125
|
- hyrax
|
124
126
|
|
125
127
|
fits:
|
126
|
-
image:
|
128
|
+
image: ghcr.io/samvera/fitsservlet:1.6.0
|
127
129
|
ports:
|
128
130
|
- 8080
|
129
131
|
networks:
|
@@ -137,14 +139,16 @@ services:
|
|
137
139
|
- hyrax
|
138
140
|
|
139
141
|
redis:
|
140
|
-
image: redis:
|
142
|
+
image: bitnami/redis:6.2
|
143
|
+
env_file:
|
144
|
+
- .dassie/.env
|
141
145
|
volumes:
|
142
|
-
- redis:/data
|
146
|
+
- redis:/bitnami/redis/data
|
143
147
|
networks:
|
144
148
|
- hyrax
|
145
149
|
|
146
150
|
solr:
|
147
|
-
image: solr:8.11
|
151
|
+
image: solr:8.11
|
148
152
|
ports:
|
149
153
|
- 8983:8983
|
150
154
|
command:
|
@@ -162,6 +166,7 @@ services:
|
|
162
166
|
- hyrax
|
163
167
|
|
164
168
|
volumes:
|
169
|
+
bundle:
|
165
170
|
db:
|
166
171
|
fcrepo:
|
167
172
|
hyrax-derivatives:
|
@@ -169,8 +174,6 @@ volumes:
|
|
169
174
|
rails-public:
|
170
175
|
rails-tmp:
|
171
176
|
redis:
|
172
|
-
sidekiq-public:
|
173
|
-
sidekiq-tmp:
|
174
177
|
solr_home:
|
175
178
|
|
176
179
|
networks:
|
@@ -29,8 +29,10 @@ A Hyrax-based application includes lots of dependencies. We provide a [Docker im
|
|
29
29
|
|
30
30
|
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.
|
31
31
|
|
32
|
+
During development, running only the dependent services in a container environment may be beneficial. This avoids potential headaches concerning file permissions and eases the use of debugging tools. The application generation instructions below use [Lando](https://lando.dev) to achieve this setup.
|
33
|
+
|
32
34
|
This document contains instructions specific to setting up an app with __Hyrax
|
33
|
-
v5.0.0.
|
35
|
+
v5.0.0.rc3__. If you are looking for instructions on installing a different
|
34
36
|
version, be sure to select the appropriate branch or tag from the drop-down
|
35
37
|
menu above.
|
36
38
|
|
@@ -44,8 +46,8 @@ Prerequisites are required for both creating a Hyrax\-based app and contributing
|
|
44
46
|
Hyrax requires the following software to work:
|
45
47
|
|
46
48
|
1. [Solr](http://lucene.apache.org/solr/) version >= 5.x (tested up to 8.11.1, which includes the log4j library update)
|
47
|
-
1. [Fedora Commons](http://www.fedora-commons.org/) digital repository version >= 4.
|
48
|
-
1. A SQL RDBMS (
|
49
|
+
1. [Fedora Commons](http://www.fedora-commons.org/) digital repository version >= 4.7.6 (if not using the Valkyrie Postgres adapter)
|
50
|
+
1. A SQL RDBMS ([PostgreSQL](https://www.postgresql.org) recommended)
|
49
51
|
1. [Redis](http://redis.io/), a key-value store
|
50
52
|
1. [ImageMagick](http://www.imagemagick.org/) with JPEG-2000 support
|
51
53
|
1. [FITS](#characterization) (tested up to version 1.5.0 -- avoid version 1.1.0)
|
@@ -55,7 +57,12 @@ Hyrax requires the following software to work:
|
|
55
57
|
**NOTE: The [Hyrax Development Guide](https://github.com/samvera/hyrax/wiki/Hyrax-Development-Guide) has instructions for installing Solr and Fedora in a development environment.**
|
56
58
|
|
57
59
|
### Characterization
|
60
|
+
#### Servlet FITS
|
61
|
+
FITS can be run as a web service. This has the benefit of improved performance by avoiding the slow startup time inherent to the local option below.
|
62
|
+
|
63
|
+
A container image is available for this purpose: [ghcr.io/samvera/fitsservlet](https://ghcr.io/samvera/fitsservlet)
|
58
64
|
|
65
|
+
#### Local FITS
|
59
66
|
FITS can be installed on OSX using Homebrew by running the command: `brew install fits`
|
60
67
|
|
61
68
|
**OR**
|
@@ -122,10 +129,21 @@ NOTE: [nodejs](https://nodejs.org/en/) is preinstalled on most Mac computers and
|
|
122
129
|
|
123
130
|
NOTE: The steps need to be done in order to create a new Hyrax based app.
|
124
131
|
|
132
|
+
### Development Prerequisites
|
133
|
+
|
134
|
+
These instructions assume the use of [Lando](https://lando.dev) and [Docker](https://docker.io) to manage the backend services needed by your Hyrax application. Follow the Lando installation instructions before proceeding, or have alternate providers for the services listed in the generated `.lando.yml`:
|
135
|
+
- Solr
|
136
|
+
- Postgres
|
137
|
+
- Redis
|
138
|
+
- FITS servlet
|
139
|
+
- Fedora (if not using Postgres)
|
140
|
+
|
141
|
+
### Generate the application
|
142
|
+
|
125
143
|
Generate a new Rails application using the template.
|
126
144
|
|
127
|
-
```
|
128
|
-
rails _6.1.7.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v5.0.0.
|
145
|
+
```shell
|
146
|
+
rails _6.1.7.6_ new my_app --database=postgresql -m https://raw.githubusercontent.com/samvera/hyrax/hyrax-v5.0.0.rc3/template.rb
|
129
147
|
```
|
130
148
|
|
131
149
|
Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:
|
@@ -133,23 +151,65 @@ Generating a new Rails application using Hyrax's template above takes cares of a
|
|
133
151
|
* Adding Hyrax (and any of its dependencies) to your application `Gemfile`, to declare that Hyrax is a dependency of your application
|
134
152
|
* Running `bundle install`, to install Hyrax and its dependencies
|
135
153
|
* Running Hyrax's install generator, to add a number of files that Hyrax requires within your Rails app, including e.g. database migrations
|
154
|
+
|
155
|
+
### Start Services
|
156
|
+
|
157
|
+
Start the background services managed by Lando. The
|
158
|
+
|
159
|
+
```shell
|
160
|
+
cd my_app
|
161
|
+
lando start
|
162
|
+
```
|
163
|
+
|
164
|
+
### Run Migrations/Seeds
|
165
|
+
|
166
|
+
This performs the following actions:
|
167
|
+
|
136
168
|
* Loading all of Hyrax's database migrations into your application's database
|
137
|
-
* Loading Hyrax's default workflows into your application's database
|
138
169
|
* Create default collection types (e.g. Admin Set, User Collection)
|
170
|
+
* Loading Hyrax's default workflows into your application's database
|
171
|
+
|
172
|
+
```shell
|
173
|
+
rails db:migrate
|
174
|
+
rails db:seed
|
175
|
+
```
|
139
176
|
|
140
|
-
|
177
|
+
**NOTE**: You will want to run these commands the first time this code is deployed to a new environment as well.
|
141
178
|
|
142
|
-
|
179
|
+
This creates the default administrative set -- into which all works will be deposited unless assigned to other administrative sets.
|
180
|
+
This command also makes sure that Hyrax's built-in workflows are loaded for your application and available for the default administrative set.
|
181
|
+
|
182
|
+
### Generate a work type
|
183
|
+
|
184
|
+
Using Hyrax requires generating at least one type of repository object, or "work type." Hyrax allows you to generate the work types required in your application by using a Rails generator-based tool. You may generate one or more of these work types.
|
185
|
+
|
186
|
+
Pass a (CamelCased) model name to Hyrax's work generator to get started, e.g.:
|
143
187
|
|
144
188
|
```
|
145
|
-
|
189
|
+
rails generate hyrax:work_resource MovingImage
|
190
|
+
```
|
191
|
+
|
192
|
+
If your applications requires your work type to be namespaced, namespaces can be included by adding a slash to the model name which creates a new class called `MovingImage` within the `My` namespace:
|
193
|
+
|
194
|
+
```shell
|
195
|
+
rails generate hyrax:work_resource My/MovingImage
|
196
|
+
```
|
197
|
+
|
198
|
+
You may wish to [customize your work type](https://github.com/samvera/hyrax/wiki/Customizing-your-work-types) now that it's been generated.
|
199
|
+
|
200
|
+
### Start Hyrax web server
|
201
|
+
|
202
|
+
Test-drive your new Hyrax application in development mode:
|
203
|
+
|
204
|
+
```shell
|
205
|
+
rails s
|
146
206
|
```
|
147
207
|
|
148
208
|
And now you should be able to browse to [localhost:3000](http://localhost:3000/) and see the application.
|
149
209
|
|
150
210
|
Notes:
|
151
211
|
* This web server is purely for development purposes. You will want to use a more fully featured [web server](https://github.com/samvera/hyrax/wiki/Hyrax-Management-Guide#web-server) for production-like environments.
|
152
|
-
*
|
212
|
+
* For a fresh start, the data persisted in Lando can be wiped using `lando destroy`.
|
153
213
|
|
154
214
|
### Start background workers
|
155
215
|
|
@@ -163,14 +223,10 @@ Many of the services performed by Hyrax are resource intensive, and therefore ar
|
|
163
223
|
|
164
224
|
Hyrax implements these jobs using the Rails [ActiveJob](http://edgeguides.rubyonrails.org/active_job_basics.html) framework, allowing you to choose the message queue system of your choice.
|
165
225
|
|
166
|
-
For initial development, it is recommended that you change the default ActiveJob adapter from `:async` to `:inline`. This adapter will execute jobs immediately (in the foreground) as they are received. This can be accomplished by
|
226
|
+
For initial development, it is recommended that you change the default ActiveJob adapter from `:async` to `:inline`. This adapter will execute jobs immediately (in the foreground) as they are received. This can be accomplished by modifying the `.env` file:
|
167
227
|
|
168
|
-
```
|
169
|
-
|
170
|
-
# ...
|
171
|
-
config.active_job.queue_adapter = :inline
|
172
|
-
# ...
|
173
|
-
end
|
228
|
+
```dotenv
|
229
|
+
HYRAX_ACTIVE_JOB_QUEUE=inline
|
174
230
|
```
|
175
231
|
|
176
232
|
For testing, it is recommended that you use the [built-in `:test` adapter](http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters/TestAdapter.html) which stores enqueued and performed jobs, running only those configured to run during test setup. To do this, add the following to `config/environments/test.rb`:
|
@@ -185,54 +241,15 @@ end
|
|
185
241
|
|
186
242
|
**For production applications** you will want to use a more robust message queue system such as [Sidekiq](http://sidekiq.org/). The Hyrax Development Guide has a detailed walkthrough of [installing and configuring Sidekiq](https://github.com/samvera/hyrax/wiki/Using-Sidekiq-with-Hyrax).
|
187
243
|
|
188
|
-
### Create
|
189
|
-
|
190
|
-
**After** Fedora and Solr are running, create the default administrative set -- into which all works will be deposited unless assigned to other administrative sets -- by running the following command:
|
191
|
-
|
192
|
-
```
|
193
|
-
rails hyrax:default_admin_set:create
|
194
|
-
```
|
195
|
-
|
196
|
-
This command also makes sure that Hyrax's built-in workflows are loaded for your application and available for the default administrative set.
|
197
|
-
|
198
|
-
**NOTE**: You will want to run this command the first time this code is deployed to a new environment as well.
|
199
|
-
|
200
|
-
### Generate a work type
|
201
|
-
|
202
|
-
Using Hyrax requires generating at least one type of repository object, or "work type." Hyrax allows you to generate the work types required in your application by using a Rails generator-based tool. You may generate one or more of these work types.
|
203
|
-
|
204
|
-
Pass a (CamelCased) model name to Hyrax's work generator to get started, e.g.:
|
205
|
-
|
206
|
-
```
|
207
|
-
rails generate hyrax:work Work
|
208
|
-
```
|
209
|
-
|
210
|
-
or
|
211
|
-
|
212
|
-
```
|
213
|
-
rails generate hyrax:work MovingImage
|
214
|
-
```
|
215
|
-
|
216
|
-
If your applications requires your work type to be namespaced, namespaces can be included by adding a slash to the model name which creates a new class called `MovingImage` within the `My` namespace:
|
217
|
-
|
218
|
-
```
|
219
|
-
rails generate hyrax:work My/MovingImage
|
220
|
-
```
|
221
|
-
|
222
|
-
You may wish to [customize your work type](https://github.com/samvera/hyrax/wiki/Customizing-your-work-types) now that it's been generated.
|
223
|
-
|
224
|
-
### Enable notifications
|
225
|
-
|
226
|
-
Hyrax 2+ uses a WebSocket-based user notifications system, which requires Redis. To enable user notifications, make sure that you have configured ActionCable to use Redis as the adapter in your application's `config/cable.yml`. E.g., for the `development` Rails environment:
|
244
|
+
### Create an Admin User
|
227
245
|
|
246
|
+
To access all of Hyrax's features you must be signed in as a user in the `admin` role. The default role management system uses the `config/role_map.yml` file to assign users to roles. For example:
|
228
247
|
```yaml
|
229
248
|
development:
|
230
|
-
|
231
|
-
|
249
|
+
admin:
|
250
|
+
- dev@test.internal
|
232
251
|
```
|
233
252
|
|
234
|
-
Note that the Hyrax Management Guide contains additional information on [how to configure ActionCable in production environments](https://github.com/samvera/hyrax/wiki/Hyrax-Management-Guide#notifications).
|
235
|
-
|
236
253
|
## Managing a Hyrax-based app
|
237
254
|
|
238
255
|
The [Hyrax Management Guide](https://github.com/samvera/hyrax/wiki/Hyrax-Management-Guide) provides tips for how to manage, customize, and enhance your Hyrax application, including guidance specific to:
|
data/hyrax.gemspec
CHANGED
@@ -17,7 +17,15 @@ SUMMARY
|
|
17
17
|
|
18
18
|
spec.homepage = "http://github.com/samvera/hyrax"
|
19
19
|
|
20
|
-
spec.files = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR).
|
20
|
+
spec.files = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR).reject do |f|
|
21
|
+
f == 'bin/rails' ||
|
22
|
+
# We want for downstream implementations to be able to leverage the various Hyrax factories.
|
23
|
+
# As such we need them to be available in the .gem file. See `./lib/hyrax/spec/factories.rb`
|
24
|
+
# for more details.
|
25
|
+
(File.dirname(f) =~ %r{\A"?spec\/?} &&
|
26
|
+
File.dirname(f) !~ %r{\A"?spec\/(factories|assets|support)\/?}
|
27
|
+
)
|
28
|
+
end
|
21
29
|
spec.executables = spec.files.grep(%r{^bin/}).map { |f| File.basename(f) }
|
22
30
|
spec.name = "hyrax"
|
23
31
|
spec.require_paths = ["lib"]
|
@@ -30,7 +38,7 @@ SUMMARY
|
|
30
38
|
# NOTE: rails does not follow sem-ver conventions, it's
|
31
39
|
# minor version releases can include breaking changes; see
|
32
40
|
# http://guides.rubyonrails.org/maintenance_policy.html
|
33
|
-
spec.add_dependency 'rails', '~> 6.
|
41
|
+
spec.add_dependency 'rails', '~> 6.1'
|
34
42
|
|
35
43
|
spec.add_dependency 'active-fedora', '~> 14.0'
|
36
44
|
spec.add_dependency 'almond-rails', '~> 0.1'
|
@@ -41,13 +49,14 @@ SUMMARY
|
|
41
49
|
spec.add_dependency 'browse-everything', '>= 0.16', '< 2.0'
|
42
50
|
spec.add_dependency 'carrierwave', '~> 1.0'
|
43
51
|
spec.add_dependency 'clipboard-rails', '~> 1.5'
|
52
|
+
spec.add_dependency 'concurrent-ruby', '~> 1.0'
|
44
53
|
spec.add_dependency 'connection_pool', '~> 2.4'
|
45
54
|
spec.add_dependency 'draper', '~> 4.0'
|
46
|
-
spec.add_dependency 'dry-
|
47
|
-
spec.add_dependency 'dry-
|
48
|
-
spec.add_dependency 'dry-
|
49
|
-
spec.add_dependency 'dry-
|
50
|
-
spec.add_dependency 'dry-validation', '~> 1.
|
55
|
+
spec.add_dependency 'dry-logic', '~> 1.5'
|
56
|
+
spec.add_dependency 'dry-container', '~> 0.11'
|
57
|
+
spec.add_dependency 'dry-events', '~> 1.0', '>= 1.0.1'
|
58
|
+
spec.add_dependency 'dry-monads', '~> 1.6'
|
59
|
+
spec.add_dependency 'dry-validation', '~> 1.10'
|
51
60
|
spec.add_dependency 'flipflop', '~> 2.3'
|
52
61
|
# Pin more tightly because 0.x gems are potentially unstable
|
53
62
|
spec.add_dependency 'flot-rails', '~> 0.0.6'
|
@@ -80,7 +89,7 @@ SUMMARY
|
|
80
89
|
spec.add_dependency 'retriable', '>= 2.9', '< 4.0'
|
81
90
|
spec.add_dependency 'signet'
|
82
91
|
spec.add_dependency 'tinymce-rails', '~> 5.10'
|
83
|
-
spec.add_dependency 'valkyrie', '~> 3.
|
92
|
+
spec.add_dependency 'valkyrie', '~> 3.1.1'
|
84
93
|
spec.add_dependency 'view_component', '~> 2.74.1' # Pin until blacklight is updated with workaround for https://github.com/ViewComponent/view_component/issues/1565
|
85
94
|
spec.add_dependency 'sprockets', '~> 3.7'
|
86
95
|
spec.add_dependency 'sass-rails', '~> 6.0'
|
@@ -89,16 +98,14 @@ SUMMARY
|
|
89
98
|
spec.add_development_dependency "capybara", '~> 3.29'
|
90
99
|
spec.add_development_dependency 'capybara-screenshot', '~> 1.0'
|
91
100
|
spec.add_development_dependency 'database_cleaner', '~> 1.3'
|
92
|
-
spec.add_development_dependency 'engine_cart', '~> 2.5'
|
93
101
|
spec.add_development_dependency "equivalent-xml", '~> 0.5'
|
94
102
|
spec.add_development_dependency "factory_bot", '~> 4.4'
|
95
|
-
spec.add_development_dependency 'fcrepo_wrapper', '~> 0.5', '>= 0.5.1'
|
96
103
|
spec.add_development_dependency 'mida', '~> 0.3'
|
97
104
|
spec.add_development_dependency 'okcomputer'
|
98
105
|
spec.add_development_dependency 'pg', '~> 1.2'
|
99
106
|
spec.add_development_dependency 'rspec-activemodel-mocks', '~> 1.0'
|
100
107
|
spec.add_development_dependency 'rspec-its', '~> 1.1'
|
101
|
-
spec.add_development_dependency 'rspec-rails', '~>
|
108
|
+
spec.add_development_dependency 'rspec-rails', '~> 6.0'
|
102
109
|
spec.add_development_dependency 'rspec_junit_formatter'
|
103
110
|
spec.add_development_dependency "selenium-webdriver", '~> 4.4'
|
104
111
|
spec.add_development_dependency 'i18n-debug'
|
@@ -108,6 +115,5 @@ SUMMARY
|
|
108
115
|
spec.add_development_dependency 'bixby', '~> 5.0', '>= 5.0.2' # bixby 5 briefly dropped Ruby 2.5
|
109
116
|
spec.add_development_dependency 'shoulda-callback-matchers', '~> 1.1.1'
|
110
117
|
spec.add_development_dependency 'shoulda-matchers', '~> 3.1'
|
111
|
-
spec.add_development_dependency 'webdrivers', '~> 4.4'
|
112
118
|
spec.add_development_dependency 'webmock'
|
113
119
|
end
|
data/karma.conf.js
CHANGED
@@ -23,7 +23,7 @@ module.exports = function(config) {
|
|
23
23
|
},
|
24
24
|
|
25
25
|
// list of files / patterns to load in the browser
|
26
|
-
// uses dotenv to allow for .
|
26
|
+
// uses dotenv to allow for .dassie as the Rails root
|
27
27
|
|
28
28
|
files: [
|
29
29
|
{pattern: 'spec/javascripts/fixtures/*.html', watched: true, included: false, served: true},
|
@@ -2,6 +2,6 @@
|
|
2
2
|
|
3
3
|
# Generated via
|
4
4
|
# `rails generate hyrax:collection_resource <%= class_name %>`
|
5
|
-
class <%= class_name %>Indexer < Hyrax::PcdmCollectionIndexer
|
5
|
+
class <%= class_name %>Indexer < Hyrax::Indexers::PcdmCollectionIndexer
|
6
6
|
include Hyrax::Indexer(:<%= file_name %>)
|
7
7
|
end
|
@@ -2,6 +2,8 @@
|
|
2
2
|
# index key names, and form properties.
|
3
3
|
#
|
4
4
|
# Attributes must have a type but all other configuration options are optional.
|
5
|
+
# Please note: If using Valkyrie's Fedora Metadata Adapter, predicates for attributes
|
6
|
+
# must be placed here.
|
5
7
|
#
|
6
8
|
# attributes:
|
7
9
|
# attribute_name:
|
@@ -38,11 +38,23 @@ class Hyrax::ConfigGenerator < Rails::Generators::Base
|
|
38
38
|
copy_file 'config/initializers/redis_config.rb'
|
39
39
|
end
|
40
40
|
|
41
|
+
def configure_valkyrie
|
42
|
+
copy_file 'config/initializers/1_valkyrie.rb'
|
43
|
+
end
|
44
|
+
|
41
45
|
def configure_valkyrie_index
|
42
46
|
copy_file 'config/valkyrie_index.yml'
|
43
47
|
copy_file 'config/solr_wrapper_valkyrie_test.yml'
|
44
48
|
end
|
45
49
|
|
50
|
+
def metadata_dir
|
51
|
+
empty_directory 'config/metadata'
|
52
|
+
end
|
53
|
+
|
54
|
+
def derivatives_file_services
|
55
|
+
copy_file 'config/initializers/file_services.rb'
|
56
|
+
end
|
57
|
+
|
46
58
|
def create_initializer_config_file
|
47
59
|
copy_file 'config/initializers/hyrax.rb'
|
48
60
|
end
|