Module: Hyrax

Extended by:
ActiveSupport::Autoload
Defined in:
lib/hyrax.rb,
lib/hyrax/name.rb,
lib/hyrax/arkivo.rb,
lib/hyrax/engine.rb,
lib/hyrax/errors.rb,
lib/hyrax/schema.rb,
lib/hyrax/zotero.rb,
lib/hyrax/indexer.rb,
lib/hyrax/version.rb,
lib/hyrax/publisher.rb,
app/models/hyrax/base.rb,
app/models/hyrax/work.rb,
lib/hyrax/event_store.rb,
lib/hyrax/form_fields.rb,
app/models/hyrax/event.rb,
app/models/hyrax/group.rb,
app/models/hyrax/lease.rb,
lib/hyrax/arkivo/actor.rb,
lib/hyrax/search_state.rb,
lib/hyrax/transactions.rb,
app/services/hyrax/noid.rb,
lib/hyrax/arkivo/config.rb,
lib/hyrax/configuration.rb,
lib/hyrax/resource_name.rb,
lib/hyrax/resource_sync.rb,
lib/hyrax/role_registry.rb,
lib/hyrax/zotero/config.rb,
app/models/hyrax/embargo.rb,
app/models/hyrax/feature.rb,
app/models/hyrax/download.rb,
app/models/hyrax/file_set.rb,
app/models/hyrax/pageview.rb,
app/models/hyrax/resource.rb,
lib/hyrax/collection_name.rb,
lib/hyrax/model_decorator.rb,
app/models/hyrax/operation.rb,
app/models/hyrax/statistic.rb,
app/models/hyrax/change_set.rb,
app/models/hyrax/permission.rb,
app/services/hyrax/lockable.rb,
app/values/hyrax/chart_data.rb,
lib/hyrax/redis_event_store.rb,
app/helpers/hyrax/url_helper.rb,
app/services/hyrax/analytics.rb,
app/services/hyrax/callbacks.rb,
app/services/hyrax/listeners.rb,
app/services/hyrax/microdata.rb,
lib/hyrax/specs/spy_listener.rb,
app/helpers/hyrax/iiif_helper.rb,
app/jobs/hyrax/grant_edit_job.rb,
app/jobs/hyrax/grant_read_job.rb,
app/models/hyrax/contact_form.rb,
app/renderers/hyrax/renderers.rb,
lib/hyrax/controller_resource.rb,
app/helpers/hyrax/lease_helper.rb,
app/jobs/hyrax/application_job.rb,
app/jobs/hyrax/revoke_edit_job.rb,
app/models/hyrax/file_metadata.rb,
app/models/hyrax/uploaded_file.rb,
app/models/hyrax/virus_scanner.rb,
app/services/hyrax/child_types.rb,
app/services/hyrax/institution.rb,
app/builders/hyrax/form_builder.rb,
app/forms/hyrax/forms/work_form.rb,
app/helpers/hyrax/charts_helper.rb,
app/helpers/hyrax/trophy_helper.rb,
app/indexers/hyrax/work_indexer.rb,
app/models/hyrax/access_control.rb,
app/presenters/hyrax/file_usage.rb,
app/presenters/hyrax/model_icon.rb,
app/presenters/hyrax/work_usage.rb,
app/services/hyrax/form_factory.rb,
app/services/hyrax/lock_manager.rb,
app/services/hyrax/solr_service.rb,
app/services/hyrax/time_service.rb,
app/forms/hyrax/forms/permission.rb,
app/helpers/hyrax/ability_helper.rb,
app/helpers/hyrax/embargo_helper.rb,
app/mailers/hyrax/contact_mailer.rb,
app/models/concerns/hyrax/naming.rb,
app/models/hyrax/collection_type.rb,
app/models/hyrax/orcid_validator.rb,
app/models/hyrax/pcdm_collection.rb,
app/presenters/hyrax/model_proxy.rb,
app/services/hyrax/lease_manager.rb,
app/services/hyrax/lease_service.rb,
lib/hyrax/arkivo/metadata_munger.rb,
lib/hyrax/transactions/container.rb,
app/models/concerns/hyrax/ability.rb,
app/models/hyrax/avatar_validator.rb,
app/services/hyrax/graph_exporter.rb,
app/services/hyrax/search_service.rb,
app/services/hyrax/visibility_map.rb,
lib/hyrax/arkivo/schema_validator.rb,
lib/hyrax/controlled_vocabularies.rb,
lib/hyrax/transactions/steps/save.rb,
app/actors/hyrax/actors/base_actor.rb,
app/actors/hyrax/actors/file_actor.rb,
app/actors/hyrax/actors/null_actor.rb,
app/actors/hyrax/actors/terminator.rb,
app/builders/hyrax/manifest_helper.rb,
app/controllers/concerns/hyrax/api.rb,
app/helpers/hyrax/work_form_helper.rb,
app/helpers/hyrax/workflows_helper.rb,
app/models/hyrax/version_committer.rb,
app/services/hyrax/contextual_path.rb,
app/services/hyrax/derivative_path.rb,
app/services/hyrax/embargo_manager.rb,
app/services/hyrax/embargo_service.rb,
app/services/hyrax/license_service.rb,
app/services/hyrax/resource_status.rb,
lib/hyrax/health_checks/solr_check.rb,
lib/hyrax/transactions/create_work.rb,
lib/hyrax/transactions/transaction.rb,
lib/hyrax/transactions/update_work.rb,
lib/hyrax/transactions/work_create.rb,
lib/hyrax/valkyrie_can_can_adapter.rb,
app/actors/hyrax/actors/environment.rb,
app/actors/hyrax/actors/lease_actor.rb,
app/actors/hyrax/actors/model_actor.rb,
app/controllers/hyrax/my_controller.rb,
app/forms/hyrax/forms/file_set_form.rb,
app/forms/hyrax/forms/resource_form.rb,
app/helpers/hyrax/membership_helper.rb,
app/indexers/hyrax/file_set_indexer.rb,
app/indexers/hyrax/indexes_workflow.rb,
app/indexers/hyrax/resource_indexer.rb,
app/indexers/hyrax/valkyrie_indexer.rb,
app/models/hyrax/administrative_set.rb,
app/presenters/hyrax/displays_image.rb,
app/presenters/hyrax/menu_presenter.rb,
app/services/hyrax/curation_concern.rb,
lib/hyrax/active_fedora_dummy_model.rb,
lib/hyrax/transactions/destroy_work.rb,
lib/hyrax/transactions/work_destroy.rb,
app/forms/hyrax/forms/admin_set_form.rb,
app/helpers/hyrax/batch_edits_helper.rb,
app/helpers/hyrax/citations_behavior.rb,
app/helpers/hyrax/collections_helper.rb,
app/helpers/hyrax/permissions_helper.rb,
app/indexers/hyrax/admin_set_indexer.rb,
app/models/hyrax/permission_template.rb,
app/presenters/hyrax/lease_presenter.rb,
app/services/hyrax/admin_set_service.rb,
app/services/hyrax/database_migrator.rb,
app/services/hyrax/messenger_service.rb,
app/services/hyrax/qa_select_service.rb,
app/services/hyrax/visibility_reader.rb,
app/services/hyrax/visibility_writer.rb,
app/services/hyrax/work_form_service.rb,
app/services/hyrax/working_directory.rb,
app/actors/hyrax/actors/embargo_actor.rb,
app/forms/hyrax/forms/batch_edit_form.rb,
app/forms/hyrax/forms/collection_form.rb,
app/helpers/hyrax/blacklight_override.rb,
app/helpers/hyrax/contact_form_helper.rb,
app/indexers/hyrax/collection_indexer.rb,
app/indexers/hyrax/permission_indexer.rb,
app/indexers/hyrax/visibility_indexer.rb,
app/models/concerns/hyrax/embargoable.rb,
app/models/concerns/hyrax/permissions.rb,
app/models/concerns/hyrax/serializers.rb,
app/models/concerns/hyrax/virus_check.rb,
app/models/concerns/hyrax/with_events.rb,
app/models/hyrax/workflow_action_info.rb,
app/presenters/hyrax/permission_badge.rb,
app/presenters/hyrax/trophy_presenter.rb,
app/services/hyrax/identifier/builder.rb,
app/services/hyrax/indexes_thumbnails.rb,
app/services/hyrax/local_file_service.rb,
app/services/hyrax/permission_manager.rb,
app/services/hyrax/solr_query_service.rb,
app/services/hyrax/user_stat_importer.rb,
app/services/hyrax/versioning_service.rb,
app/services/hyrax/work_query_service.rb,
lib/hyrax/transactions/steps/validate.rb,
app/actors/hyrax/actors/abstract_actor.rb,
app/actors/hyrax/actors/file_set_actor.rb,
app/connections/hyrax/clean_connection.rb,
app/controllers/hyrax/pages_controller.rb,
app/controllers/hyrax/stats_controller.rb,
app/controllers/hyrax/users_controller.rb,
app/forms/hyrax/forms/admin/appearance.rb,
app/helpers/hyrax/content_block_helper.rb,
app/models/concerns/hyrax/in_admin_set.rb,
app/models/concerns/hyrax/nested_works.rb,
app/models/concerns/hyrax/suppressible.rb,
app/presenters/hyrax/embargo_presenter.rb,
app/presenters/hyrax/presenter_factory.rb,
app/presenters/hyrax/twitter_presenter.rb,
app/presenters/hyrax/version_presenter.rb,
app/services/hyrax/access_control_list.rb,
app/services/hyrax/collections_service.rb,
app/services/hyrax/persist_derivatives.rb,
app/services/hyrax/restriction_service.rb,
lib/generators/hyrax/install_generator.rb,
lib/hyrax/transactions/steps/save_work.rb,
app/controllers/hyrax/leases_controller.rb,
app/controllers/hyrax/static_controller.rb,
app/forms/hyrax/forms/batch_upload_form.rb,
app/forms/hyrax/forms/file_manager_form.rb,
app/helpers/hyrax/hyrax_helper_behavior.rb,
app/indexers/hyrax/repository_reindexer.rb,
app/models/concerns/hyrax/core_metadata.rb,
app/models/concerns/hyrax/proxy_deposit.rb,
app/models/concerns/hyrax/work_behavior.rb,
app/models/hyrax/batch_create_operation.rb,
app/presenters/hyrax/file_set_presenter.rb,
app/presenters/hyrax/homepage_presenter.rb,
app/presenters/hyrax/presenter_renderer.rb,
app/presenters/hyrax/workflow_presenter.rb,
app/search_builders/hyrax/single_result.rb,
app/search_builders/hyrax/work_relation.rb,
app/services/hyrax/file_set_csv_service.rb,
app/services/hyrax/identifier/registrar.rb,
app/services/hyrax/list_source_exporter.rb,
app/services/hyrax/simple_schema_loader.rb,
app/services/hyrax/statistics/over_time.rb,
app/services/hyrax/visibility_intention.rb,
app/services/hyrax/work_uploads_handler.rb,
lib/hyrax/transactions/apply_change_set.rb,
lib/hyrax/transactions/file_set_destroy.rb,
app/channels/hyrax/notifications_channel.rb,
app/controllers/hyrax/uploads_controller.rb,
app/indexers/hyrax/deep_indexing_service.rb,
app/indexers/hyrax/valkyrie_work_indexer.rb,
app/jobs/hyrax/grant_edit_to_members_job.rb,
app/jobs/hyrax/grant_read_to_members_job.rb,
app/models/concerns/hyrax/basic_metadata.rb,
app/models/concerns/hyrax/with_file_sets.rb,
app/presenters/hyrax/admin_set_presenter.rb,
app/presenters/hyrax/presents_attributes.rb,
app/presenters/hyrax/transfers_presenter.rb,
app/presenters/hyrax/work_show_presenter.rb,
app/search_builders/hyrax/filter_by_type.rb,
app/search_builders/hyrax/search_builder.rb,
app/search_builders/hyrax/search_filters.rb,
app/services/hyrax/file_set_type_service.rb,
app/services/hyrax/form_metadata_service.rb,
app/services/hyrax/identifier/dispatcher.rb,
app/services/hyrax/statistics/term_query.rb,
app/services/hyrax/virus_checker_service.rb,
app/services/hyrax/visibility_propagator.rb,
lib/hyrax/arkivo/create_subscription_job.rb,
lib/hyrax/valkyrie_simple_path_generator.rb,
app/actors/hyrax/actors/add_to_work_actor.rb,
app/actors/hyrax/actors/apply_order_actor.rb,
app/controllers/hyrax/my/works_controller.rb,
app/controllers/hyrax/trophies_controller.rb,
app/indexers/hyrax/basic_metadata_indexer.rb,
app/models/hyrax/valkyrie_global_id_proxy.rb,
app/presenters/hyrax/collection_presenter.rb,
app/presenters/hyrax/page_title_decorator.rb,
app/services/hyrax/resource_types_service.rb,
app/services/hyrax/statistics/works/count.rb,
app/services/hyrax/thumbnail_path_service.rb,
lib/generators/hyrax/collection_generator.rb,
lib/hyrax/transactions/steps/destroy_work.rb,
app/controllers/concerns/hyrax/breadcrumbs.rb,
app/controllers/concerns/hyrax/collections.rb,
app/controllers/hyrax/api/items_controller.rb,
app/controllers/hyrax/citations_controller.rb,
app/controllers/hyrax/dashboard_controller.rb,
app/controllers/hyrax/downloads_controller.rb,
app/controllers/hyrax/embargoes_controller.rb,
app/controllers/hyrax/file_sets_controller.rb,
app/controllers/hyrax/my/shares_controller.rb,
app/controllers/hyrax/transfers_controller.rb,
app/forms/hyrax/forms/workflow_action_form.rb,
app/helpers/hyrax/permission_levels_helper.rb,
app/indexers/hyrax/pcdm_collection_indexer.rb,
app/presenters/hyrax/admin/users_presenter.rb,
app/presenters/hyrax/admin_stats_presenter.rb,
app/presenters/hyrax/select_type_presenter.rb,
app/presenters/hyrax/stats_usage_presenter.rb,
app/services/hyrax/statistics/system_stats.rb,
app/services/hyrax/tolerant_select_service.rb,
app/services/hyrax/works/migration_service.rb,
app/uploaders/hyrax/uploaded_file_uploader.rb,
lib/generators/hyrax/sample_data_generator.rb,
lib/hyrax/controlled_vocabularies/location.rb,
lib/hyrax/resource_sync/change_list_writer.rb,
lib/hyrax/transactions/steps/add_file_sets.rb,
lib/hyrax/transactions/steps/add_to_parent.rb,
app/actors/hyrax/actors/featured_work_actor.rb,
app/controllers/hyrax/api/zotero_controller.rb,
app/controllers/hyrax/depositors_controller.rb,
app/controllers/hyrax/operations_controller.rb,
app/helpers/hyrax/dashboard_helper_behavior.rb,
app/jobs/hyrax/revoke_edit_from_members_job.rb,
app/models/concerns/hyrax/file_set/indexing.rb,
app/models/concerns/hyrax/file_set/querying.rb,
app/models/concerns/hyrax/file_set_behavior.rb,
app/models/hyrax/permission_template_access.rb,
app/presenters/hyrax/inspect_work_presenter.rb,
app/presenters/hyrax/user_profile_presenter.rb,
app/presenters/hyrax/version_list_presenter.rb,
app/search_builders/hyrax/filter_suppressed.rb,
app/search_builders/hyrax/my/search_builder.rb,
app/services/hyrax/abstract_message_service.rb,
app/services/hyrax/admin_set_create_service.rb,
app/services/hyrax/admin_set_member_service.rb,
app/services/hyrax/default_middleware_stack.rb,
app/services/hyrax/edit_permissions_service.rb,
app/services/hyrax/manifest_builder_service.rb,
app/services/hyrax/rights_statement_service.rb,
app/services/hyrax/statistics/query_service.rb,
app/services/hyrax/workflow/activate_object.rb,
app/services/hyrax/workflow/workflow_schema.rb,
app/actors/hyrax/actors/attach_members_actor.rb,
app/channels/hyrax/application_cable/channel.rb,
app/controllers/hyrax/admin/stats_controller.rb,
app/controllers/hyrax/admin/users_controller.rb,
app/controllers/hyrax/batch_edits_controller.rb,
app/controllers/hyrax/collections_controller.rb,
app/controllers/hyrax/permissions_controller.rb,
app/indexers/hyrax/valkyrie_file_set_indexer.rb,
app/models/concerns/hyrax/collection_nesting.rb,
app/models/hyrax/collection_type_participant.rb,
app/presenters/hyrax/fixity_status_presenter.rb,
app/presenters/hyrax/iiif_manifest_presenter.rb,
app/services/hyrax/collection_member_service.rb,
app/services/hyrax/workflow/method_generator.rb,
app/services/hyrax/workflow/permission_query.rb,
app/services/hyrax/workflow/workflow_factory.rb,
app/validators/hyrax/has_one_title_validator.rb,
lib/hyrax/resource_sync/resource_list_writer.rb,
lib/hyrax/transactions/steps/delete_resource.rb,
app/actors/hyrax/actors/ordered_members_actor.rb,
app/actors/hyrax/actors/transactional_request.rb,
app/controllers/hyrax/contact_form_controller.rb,
app/indexers/hyrax/administrative_set_indexer.rb,
app/models/concerns/hyrax/collection_behavior.rb,
app/models/concerns/hyrax/human_readable_type.rb,
app/presenters/hyrax/dashboard/user_presenter.rb,
app/presenters/hyrax/google_scholar_presenter.rb,
app/presenters/hyrax/member_presenter_factory.rb,
app/search_builders/hyrax/work_search_builder.rb,
app/services/hyrax/collections/search_service.rb,
app/services/hyrax/iiif_authorization_service.rb,
app/services/hyrax/import_url_failure_service.rb,
app/services/hyrax/quick_classification_query.rb,
app/services/hyrax/solr_query_builder_service.rb,
app/services/hyrax/statistics/users/over_time.rb,
app/services/hyrax/statistics/works/over_time.rb,
app/services/hyrax/workflow/deactivate_object.rb,
app/services/hyrax/workflow/workflow_importer.rb,
lib/hyrax/transactions/steps/apply_visibility.rb,
lib/hyrax/transactions/steps/ensure_admin_set.rb,
app/actors/hyrax/actors/cleanup_trophies_actor.rb,
app/actors/hyrax/actors/transfer_request_actor.rb,
app/controllers/hyrax/batch_uploads_controller.rb,
app/controllers/hyrax/fixity_checks_controller.rb,
app/controllers/hyrax/my/highlights_controller.rb,
app/controllers/hyrax/notifications_controller.rb,
app/forms/hyrax/forms/permission_template_form.rb,
app/indexers/hyrax/valkyrie_collection_indexer.rb,
app/models/concerns/hyrax/file_set/derivatives.rb,
app/models/concerns/hyrax/permissions/readable.rb,
app/models/concerns/hyrax/permissions/writable.rb,
app/models/concerns/hyrax/solr_document/export.rb,
app/presenters/hyrax/admin/dashboard_presenter.rb,
app/presenters/hyrax/characterization_behavior.rb,
app/presenters/hyrax/single_use_link_presenter.rb,
app/search_builders/hyrax/lease_search_builder.rb,
app/search_builders/hyrax/works_search_builder.rb,
app/services/hyrax/listeners/workflow_listener.rb,
app/services/hyrax/multiple_membership_checker.rb,
app/services/hyrax/work_thumbnail_path_service.rb,
app/services/hyrax/workflow/actionable_objects.rb,
app/services/hyrax/works/managed_works_service.rb,
lib/hyrax/resource_sync/capability_list_writer.rb,
lib/hyrax/transactions/steps/set_modified_date.rb,
app/actors/hyrax/actors/cleanup_file_sets_actor.rb,
app/actors/hyrax/actors/create_with_files_actor.rb,
app/actors/hyrax/actors/default_admin_set_actor.rb,
app/channels/hyrax/application_cable/connection.rb,
app/controllers/hyrax/admin/features_controller.rb,
app/controllers/hyrax/content_blocks_controller.rb,
app/controllers/hyrax/featured_works_controller.rb,
app/controllers/hyrax/my/collections_controller.rb,
app/helpers/hyrax/content_block_helper_behavior.rb,
app/jobs/concerns/hyrax/permission_job_behavior.rb,
app/presenters/hyrax/select_type_list_presenter.rb,
app/services/hyrax/batch_create_failure_service.rb,
app/services/hyrax/batch_create_success_service.rb,
app/services/hyrax/file_set_derivatives_service.rb,
app/services/hyrax/fixity/missing_content_error.rb,
app/services/hyrax/fixity_check_failure_service.rb,
app/services/hyrax/listeners/acl_index_listener.rb,
app/services/hyrax/workflow/status_list_service.rb,
lib/hyrax/transactions/steps/add_to_collections.rb,
app/controllers/concerns/hyrax/manages_embargoes.rb,
app/controllers/hyrax/admin/workflows_controller.rb,
app/controllers/hyrax/dashboard/works_controller.rb,
app/forms/hyrax/forms/admin/collection_type_form.rb,
app/helpers/hyrax/citations_behaviors/formatters.rb,
app/models/concerns/hyrax/solr_document/metadata.rb,
app/models/concerns/hyrax/solr_document_behavior.rb,
app/presenters/hyrax/admin_set_options_presenter.rb,
app/presenters/hyrax/composite_presenter_factory.rb,
app/renderers/hyrax/renderers/attribute_renderer.rb,
app/search_builders/hyrax/abstract_type_relation.rb,
app/search_builders/hyrax/deposit_search_builder.rb,
app/search_builders/hyrax/embargo_search_builder.rb,
app/services/hyrax/caching_iiif_manifest_builder.rb,
app/services/hyrax/collections/migration_service.rb,
app/services/hyrax/file_set_fixity_check_service.rb,
app/services/hyrax/find_objects_via_solr_service.rb,
app/services/hyrax/statistics/depositors/summary.rb,
app/services/hyrax/statistics/works/by_depositor.rb,
app/services/hyrax/workflow/action_taken_service.rb,
app/services/hyrax/workflow/notification_service.rb,
app/services/hyrax/workflow/permission_generator.rb,
lib/hyrax/transactions/steps/save_access_control.rb,
app/actors/hyrax/actors/active_fedora_to_valkyrie.rb,
app/actors/hyrax/actors/initialize_workflow_actor.rb,
app/actors/hyrax/actors/optimistic_lock_validator.rb,
app/actors/hyrax/actors/valkyrie_to_active_fedora.rb,
app/controllers/hyrax/admin/admin_sets_controller.rb,
app/controllers/hyrax/admin/strategies_controller.rb,
app/controllers/hyrax/single_use_links_controller.rb,
app/controllers/hyrax/workflow_actions_controller.rb,
app/search_builders/hyrax/exposed_models_relation.rb,
app/search_builders/hyrax/file_set_search_builder.rb,
app/search_builders/hyrax/my/works_search_builder.rb,
app/services/hyrax/adapters/nesting_index_adapter.rb,
app/services/hyrax/file_set_visibility_propagator.rb,
app/services/hyrax/permission_template_applicator.rb,
app/services/hyrax/resource_visibility_propagator.rb,
app/services/hyrax/statistics/file_sets/by_format.rb,
app/services/hyrax/workflow/abstract_notification.rb,
lib/hyrax/controlled_vocabulary/importer/language.rb,
lib/hyrax/resource_sync/source_description_writer.rb,
app/actors/hyrax/actors/interpret_visibility_actor.rb,
app/controllers/hyrax/admin/appearances_controller.rb,
app/forms/hyrax/forms/widgets/admin_set_visibility.rb,
app/forms/hyrax/forms/workflow_responsibility_form.rb,
app/indexers/concerns/hyrax/indexes_basic_metadata.rb,
app/presenters/hyrax/admin/user_activity_presenter.rb,
app/presenters/hyrax/admin/workflow_role_presenter.rb,
app/presenters/hyrax/admin_set_selection_presenter.rb,
app/presenters/hyrax/collapsable_section_presenter.rb,
app/presenters/hyrax/pcdm_member_presenter_factory.rb,
app/renderers/hyrax/renderers/configured_microdata.rb,
app/search_builders/hyrax/admin_set_search_builder.rb,
app/services/hyrax/collection_types/create_service.rb,
app/services/hyrax/collections/permissions_service.rb,
app/services/hyrax/repository_fixity_check_service.rb,
app/services/hyrax/visibility_intention_applicator.rb,
app/services/hyrax/workflow/deposited_notification.rb,
app/services/hyrax/workflow/notification_generator.rb,
lib/hyrax/transactions/steps/set_default_admin_set.rb,
lib/hyrax/transactions/steps/set_user_as_depositor.rb,
app/controllers/concerns/hyrax/admin/stats_behavior.rb,
app/controllers/hyrax/dashboard/profiles_controller.rb,
app/helpers/hyrax/citations_behaviors/name_behavior.rb,
app/indexers/concerns/hyrax/indexes_linked_metadata.rb,
app/models/concerns/hyrax/ability/admin_set_ability.rb,
app/models/concerns/hyrax/file_set/belongs_to_works.rb,
app/models/concerns/hyrax/file_set/characterization.rb,
app/presenters/hyrax/admin/workflow_roles_presenter.rb,
app/search_builders/hyrax/collection_search_builder.rb,
app/services/hyrax/change_content_depositor_service.rb,
app/services/hyrax/custom_queries/find_ids_by_model.rb,
app/services/hyrax/listeners/proxy_deposit_listener.rb,
app/services/hyrax/statistics/collections/over_time.rb,
app/services/hyrax/workflow/grant_edit_to_depositor.rb,
app/services/hyrax/workflow/grant_read_to_depositor.rb,
app/services/hyrax/workflow/state_machine_generator.rb,
app/services/hyrax/workflow/workflow_action_service.rb,
lib/hyrax/controlled_vocabulary/importer/downloader.rb,
app/actors/hyrax/actors/collections_membership_actor.rb,
app/controllers/concerns/hyrax/breadcrumbs_for_works.rb,
app/controllers/hyrax/featured_work_lists_controller.rb,
app/forms/hyrax/forms/dashboard/nest_collection_form.rb,
app/forms/hyrax/forms/failed_submission_form_wrapper.rb,
app/helpers/hyrax/citations_behaviors/title_behavior.rb,
app/models/concerns/hyrax/ability/collection_ability.rb,
app/services/hyrax/collection_thumbnail_path_service.rb,
app/services/hyrax/custom_queries/find_file_metadata.rb,
app/services/hyrax/listeners/member_cleanup_listener.rb,
app/services/hyrax/listeners/metadata_index_listener.rb,
app/services/hyrax/listeners/trophy_cleanup_listener.rb,
app/services/hyrax/statistics/works/by_resource_type.rb,
app/services/hyrax/workflow/sipity_actions_generator.rb,
app/controllers/hyrax/admin/workflow_roles_controller.rb,
app/helpers/hyrax/citations_behaviors/common_behavior.rb,
app/presenters/hyrax/select_collection_type_presenter.rb,
app/renderers/hyrax/renderers/date_attribute_renderer.rb,
app/services/hyrax/custom_queries/find_access_control.rb,
app/actors/hyrax/actors/create_with_remote_files_actor.rb,
app/actors/hyrax/actors/file_set_ordered_members_actor.rb,
app/controllers/hyrax/dashboard/collections_controller.rb,
app/forms/hyrax/forms/widgets/admin_set_embargo_period.rb,
app/presenters/hyrax/admin/repository_growth_presenter.rb,
app/presenters/hyrax/admin/repository_object_presenter.rb,
app/search_builders/hyrax/expired_lease_search_builder.rb,
app/search_builders/hyrax/filter_suppressed_with_roles.rb,
app/services/hyrax/fixity/active_fedora_fixity_service.rb,
app/services/hyrax/listeners/object_lifecycle_listener.rb,
app/services/hyrax/workflow/revoke_edit_from_depositor.rb,
lib/hyrax/transactions/steps/apply_permission_template.rb,
lib/hyrax/transactions/steps/remove_file_set_from_work.rb,
app/actors/hyrax/actors/apply_permission_template_actor.rb,
app/controllers/concerns/hyrax/themed_layout_controller.rb,
app/controllers/hyrax/admin/collection_types_controller.rb,
app/jobs/concerns/hyrax/members_permission_job_behavior.rb,
app/models/concerns/hyrax/ability/solr_document_ability.rb,
app/models/concerns/hyrax/solr_document/ordered_members.rb,
app/renderers/hyrax/renderers/linked_attribute_renderer.rb,
app/services/hyrax/collection_types/permissions_service.rb,
app/services/hyrax/custom_queries/navigators/find_files.rb,
app/services/hyrax/ensure_well_formed_admin_set_service.rb,
app/services/hyrax/workflow/pending_review_notification.rb,
lib/generators/hyrax/templates/config/arkivo_constraint.rb,
lib/hyrax/transactions/steps/ensure_permission_template.rb,
app/controllers/concerns/hyrax/works_controller_behavior.rb,
app/controllers/hyrax/single_use_links_viewer_controller.rb,
app/models/concerns/hyrax/solr_document/characterization.rb,
app/renderers/hyrax/renderers/faceted_attribute_renderer.rb,
app/renderers/hyrax/renderers/license_attribute_renderer.rb,
app/search_builders/hyrax/dashboard/works_search_builder.rb,
app/search_builders/hyrax/expired_embargo_search_builder.rb,
app/search_builders/hyrax/single_use_link_search_builder.rb,
app/services/hyrax/characterization/file_set_description.rb,
app/services/hyrax/collections/collection_member_service.rb,
app/services/hyrax/listeners/batch_notification_listener.rb,
app/services/hyrax/listeners/file_set_lifecycle_listener.rb,
app/services/hyrax/workflow/object_in_workflow_decorator.rb,
app/controllers/concerns/hyrax/leases_controller_behavior.rb,
app/indexers/hyrax/collection_with_basic_metadata_indexer.rb,
app/models/concerns/hyrax/ability/collection_type_ability.rb,
app/search_builders/hyrax/single_admin_set_search_builder.rb,
app/services/hyrax/collections/permissions_create_service.rb,
app/services/hyrax/workflow/changes_required_notification.rb,
app/controllers/concerns/hyrax/breadcrumbs_for_collections.rb,
app/controllers/concerns/hyrax/collections/accepts_batches.rb,
app/helpers/hyrax/citations_behaviors/publication_behavior.rb,
app/presenters/hyrax/select_collection_type_list_presenter.rb,
app/search_builders/hyrax/collection_member_search_builder.rb,
app/search_builders/hyrax/dashboard/managed_search_filters.rb,
app/search_builders/hyrax/deactivated_lease_search_builder.rb,
app/search_builders/hyrax/member_with_files_search_builder.rb,
app/search_builders/hyrax/parent_collection_search_builder.rb,
app/search_builders/hyrax/single_collection_search_builder.rb,
app/search_builders/hyrax/stats/work_status_search_builder.rb,
app/services/hyrax/collections/managed_collections_service.rb,
app/services/hyrax/custom_queries/find_collections_by_type.rb,
app/services/hyrax/workflow/workflow_permissions_generator.rb,
app/controllers/hyrax/admin/permission_templates_controller.rb,
app/controllers/hyrax/dashboard/nest_collections_controller.rb,
app/services/hyrax/workflow/invalid_state_removal_exception.rb,
app/controllers/concerns/hyrax/deny_access_override_behavior.rb,
app/controllers/concerns/hyrax/embargoes_controller_behavior.rb,
app/forms/hyrax/forms/admin/collection_type_participant_form.rb,
app/search_builders/hyrax/deactivated_embargo_search_builder.rb,
app/services/hyrax/custom_queries/find_many_by_alternate_ids.rb,
app/controllers/hyrax/dashboard/collection_members_controller.rb,
app/models/concerns/hyrax/ability/permission_template_ability.rb,
app/services/hyrax/listeners/active_fedora_acl_index_listener.rb,
lib/hyrax/transactions/steps/set_uploaded_date_unless_present.rb,
app/controllers/concerns/hyrax/admin/users_controller_behavior.rb,
app/controllers/concerns/hyrax/collections_controller_behavior.rb,
app/controllers/concerns/hyrax/singular_subresource_controller.rb,
app/helpers/hyrax/citations_behaviors/formatters/apa_formatter.rb,
app/helpers/hyrax/citations_behaviors/formatters/mla_formatter.rb,
app/renderers/hyrax/renderers/external_link_attribute_renderer.rb,
app/search_builders/hyrax/dashboard/collections_search_builder.rb,
app/services/hyrax/collections/nested_collection_query_service.rb,
app/actors/hyrax/actors/create_with_files_ordered_members_actor.rb,
app/search_builders/hyrax/admin_admin_set_member_search_builder.rb,
app/services/hyrax/collections/collection_member_search_service.rb,
app/services/hyrax/custom_queries/navigators/collection_members.rb,
app/services/hyrax/workflow/notification_configuration_parameter.rb,
app/renderers/hyrax/renderers/rights_statement_attribute_renderer.rb,
app/services/hyrax/persist_directly_contained_output_file_service.rb,
lib/hyrax/transactions/steps/apply_collection_permission_template.rb,
app/helpers/hyrax/citations_behaviors/formatters/chicago_formatter.rb,
app/search_builders/hyrax/nested_collections_parent_search_builder.rb,
app/services/hyrax/custom_queries/navigators/child_works_navigator.rb,
app/controllers/hyrax/admin/collection_type_participants_controller.rb,
app/controllers/hyrax/admin/permission_template_accesses_controller.rb,
app/helpers/hyrax/citations_behaviors/formatters/open_url_formatter.rb,
app/services/hyrax/collections/nested_collection_persistence_service.rb,
app/search_builders/hyrax/dashboard/nested_collections_search_builder.rb,
app/services/hyrax/custom_queries/navigators/child_filesets_navigator.rb,
app/services/hyrax/listeners/file_set_lifecycle_notification_listener.rb,
app/actors/hyrax/actors/create_with_remote_files_ordered_members_actor.rb,
app/controllers/concerns/hyrax/local_file_downloads_controller_behavior.rb,
app/services/hyrax/custom_queries/navigators/child_collections_navigator.rb,
app/services/hyrax/custom_queries/navigators/parent_collections_navigator.rb

Overview

Hyrax is a Ruby on Rails Engine built by the Samvera community. The engine provides a foundation for creating many different digital repository applications.

Defined Under Namespace

Modules: API, Ability, AbilityHelper, Actors, Adapters, Admin, Analytics, ApplicationCable, Arkivo, BasicMetadata, BatchEditsHelper, BlacklightOverride, Breadcrumbs, BreadcrumbsForCollections, BreadcrumbsForWorks, Callbacks, Characterization, CharacterizationBehavior, ChartsHelper, CitationsBehavior, CitationsBehaviors, CollectionBehavior, CollectionNesting, CollectionTypes, Collections, CollectionsControllerBehavior, CollectionsHelper, ContactFormHelper, ContentBlockHelper, ContentBlockHelperBehavior, ControlledVocabularies, ControlledVocabulary, Controller, CoreMetadata, CustomQueries, Dashboard, DashboardHelperBehavior, DenyAccessOverrideBehavior, DisplaysImage, EmbargoHelper, Embargoable, EmbargoesControllerBehavior, EnsureWellFormedAdminSetService, FileSetBehavior, FileSetHelper, FilterByType, FilterSuppressed, FilterSuppressedWithRoles, Fixity, Forms, HasRendering, HasRepresentative, HealthChecks, HumanReadableType, HyraxHelperBehavior, Identifier, IiifHelper, InAdminSet, IndexesBasicMetadata, IndexesLinkedMetadata, IndexesThumbnails, IndexesWorkflow, LeaseHelper, LeasesControllerBehavior, Listeners, LocalFileDownloadsControllerBehavior, Lockable, ManagesEmbargoes, MembersPermissionJobBehavior, MembershipHelper, ModelProxy, My, Naming, NestedWorks, Noid, PermissionIndexer, PermissionJobBehavior, PermissionLevelsHelper, Permissions, PermissionsHelper, PresentsAttributes, ProxyDeposit, Renderers, RepositoryReindexer, ResourceIndexer, ResourceSync, ResourceTypesService, SearchFilters, Serializers, SingleResult, SingularSubresourceController, SolrDocument, SolrDocumentBehavior, Specs, Statistics, Stats, Strategies, Suppressible, ThemedLayoutController, TitleHelper, Transactions, TrophyHelper, TwitterPresenter, UrlHelper, User, UserUsageStats, VirusCheck, VisibilityIndexer, WithEvents, WithFileSets, WorkBehavior, WorkFormHelper, Workflow, WorkflowsHelper, Works, WorksControllerBehavior, Zotero Classes: AbstractMessageService, AbstractTypeRelation, AccessControl, AccessControlList, ActiveFedoraDummyModel, AdminAdminSetMemberSearchBuilder, AdminSetCreateService, AdminSetIndexer, AdminSetMemberService, AdminSetOptionsPresenter, AdminSetPresenter, AdminSetSearchBuilder, AdminSetSelectionPresenter, AdminSetService, AdminStatsPresenter, AdministrativeSet, AdministrativeSetIndexer, ApplicationJob, ArkivoApiGenerator, ArkivoConstraint, AssetsGenerator, AvatarUploader, AvatarValidator, Base, BasicMetadataIndexer, BatchCreateFailureService, BatchCreateOperation, BatchCreateSuccessService, BatchEditsController, BatchUploadsController, BootstrapBreadcrumbsBuilder, CachingIiifManifestBuilder, CatalogSearchBuilder, ChangeContentDepositorService, ChangeSet, ChartData, ChildTypes, CitationsController, ClamavGenerator, CleanConnection, CollapsableSectionPresenter, CollectionGenerator, CollectionIndexer, CollectionMemberSearchBuilder, CollectionMemberService, CollectionName, CollectionPresenter, CollectionSearchBuilder, CollectionThumbnailPathService, CollectionType, CollectionTypeParticipant, CollectionWithBasicMetadataIndexer, CollectionsController, CollectionsService, CompositePresenterFactory, ConfigGenerator, Configuration, ContactForm, ContactFormController, ContactMailer, ContentBlocksController, ContextualPath, ControllerResource, CurationConcern, DashboardController, DatabaseMigrator, DeactivatedEmbargoSearchBuilder, DeactivatedLeaseSearchBuilder, DeepIndexingService, DefaultMiddlewareStack, DepositSearchBuilder, DepositorsController, DerivativePath, DerivativeService, Download, DownloadsController, EditPermissionsService, Embargo, EmbargoManager, EmbargoPresenter, EmbargoSearchBuilder, EmbargoService, EmbargoesController, Engine, Event, EventStore, ExpiredEmbargoSearchBuilder, ExpiredLeaseSearchBuilder, ExposedModelsRelation, Feature, FeaturedWorkListsController, FeaturedWorksController, FileMetadata, FileSet, FileSetCSVService, FileSetDerivativesService, FileSetFixityCheckService, FileSetIndexer, FileSetPresenter, FileSetSearchBuilder, FileSetTypeService, FileSetVisibilityPropagator, FileSetsController, FileUsage, FindObjectsViaSolrService, FixityCheckFailureService, FixityChecksController, FixityStatusPresenter, FormBuilder, FormFactory, FormFields, FormMetadataService, GoogleScholarPresenter, GrantEditJob, GrantEditToMembersJob, GrantReadJob, GrantReadToMembersJob, GraphExporter, Group, HasOneTitleValidator, HealthCheckGenerator, HomepageController, HomepagePresenter, HomepageSearchBuilder, HyraxError, IIIFAuthorizationService, IiifManifestPresenter, ImportUrlFailureService, Indexer, InspectWorkPresenter, Install, Institution, Lease, LeaseManager, LeasePresenter, LeaseSearchBuilder, LeaseService, LeasesController, LicenseService, ListSourceExporter, LocalFileService, LockManager, ManifestBuilderService, ManifestHelper, MemberPresenterFactory, MemberWithFilesSearchBuilder, MenuPresenter, MessengerService, Microdata, MissingWorkflowError, ModelDecorator, ModelIcon, ModelsGenerator, MultipleMembershipChecker, MyController, Name, NestedCollectionsParentSearchBuilder, NotificationsChannel, NotificationsController, ObjectNotFoundError, Operation, OperationsController, OrcidValidator, PageTitleDecorator, PagesController, Pageview, ParentCollectionSearchBuilder, PcdmCollection, PcdmCollectionIndexer, PcdmMemberPresenterFactory, Permission, PermissionBadge, PermissionManager, PermissionTemplate, PermissionTemplateAccess, PermissionTemplateApplicator, PermissionsController, PersistDerivatives, PersistDirectlyContainedOutputFileService, PresenterFactory, PresenterRenderer, Publisher, QaSelectService, QuickClassificationQuery, RedisEventStore, RepositoryFixityCheckService, Resource, ResourceName, ResourceStatus, ResourceSyncController, ResourceVisibilityPropagator, RestrictionService, RevokeEditFromMembersJob, RevokeEditJob, RightsStatementService, RiiifGenerator, RoleRegistry, SampleDataGenerator, Schema, SearchBuilder, SearchService, SearchState, SelectCollectionTypeListPresenter, SelectCollectionTypePresenter, SelectTypeListPresenter, SelectTypePresenter, SimpleSchemaLoader, SingleAdminSetSearchBuilder, SingleCollectionSearchBuilder, SingleMembershipError, SingleUseError, SingleUseLinkPresenter, SingleUseLinkSearchBuilder, SingleUseLinksController, SingleUseLinksViewerController, SolrQueryBuilderService, SolrQueryService, SolrService, StaticController, Statistic, StatsController, StatsUsagePresenter, ThumbnailPathService, TimeService, TolerantSelectService, TransfersController, TransfersPresenter, TrophiesController, TrophyPresenter, UploadedFile, UploadedFileUploader, UploadsController, UserProfilePresenter, UserStatImporter, UsersController, ValkyrieCanCanAdapter, ValkyrieCollectionIndexer, ValkyrieFileSetIndexer, ValkyrieGlobalIdProxy, ValkyrieIndexer, ValkyrieSimplePathGenerator, ValkyrieWorkIndexer, VersionCommitter, VersionListPresenter, VersionPresenter, VersioningService, VirusCheckerService, VirusScanner, VisibilityIntention, VisibilityIntentionApplicator, VisibilityMap, VisibilityPropagator, VisibilityReader, VisibilityWriter, Work, WorkFormService, WorkGenerator, WorkIndexer, WorkQueryService, WorkRelation, WorkResourceGenerator, WorkSearchBuilder, WorkShowPresenter, WorkThumbnailPathService, WorkUploadsHandler, WorkUsage, WorkflowActionInfo, WorkflowActionsController, WorkflowAuthorizationException, WorkflowPresenter, WorkingDirectory, WorksSearchBuilder

Constant Summary collapse

VERSION =
'3.1.0'

Class Method Summary collapse

Class Method Details

.AccessControlList(obj) ⇒ Hyrax::AccessControlList

Cast an object to its AccessControlList

Parameters:

  • an (Object)

    object to try to cast

Returns:


12
13
14
15
16
17
18
19
# File 'app/services/hyrax/access_control_list.rb', line 12

def self.AccessControlList(obj)
  case obj
  when AccessControlList
    obj
  else
    obj.try(:permission_manager)&.acl || AccessControlList.new(resource: obj)
  end
end

.ChangeSet(resource_class) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Build a changeset class for the given resource class. The ChangeSet will have fields to match the resource class given.

To define a custom changeset with validations, use naming convention with “ChangeSet” appended to the end of the resource class name. (e.g. for BookResource, name the change set BookResourceChangeSet)

Examples:

Hyrax::ChangeSet(Monograph)

15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# File 'app/models/hyrax/change_set.rb', line 15

def self.ChangeSet(resource_class)
  klass = (resource_class.to_s + "ChangeSet").safe_constantize || Hyrax::ChangeSet
  Class.new(klass) do
    (resource_class.fields - resource_class.reserved_attributes).each do |field|
      property field, default: nil
    end

    ##
    # @return [String]
    def self.inspect
      return "Hyrax::ChangeSet(#{model_class})" if name.blank?
      super
    end
  end
end

.config {|Hyrax::Configuration| ... } ⇒ Hyrax::Configuration

Exposes the Hyrax configuration

Yields:

Returns:

See Also:


72
73
74
75
76
77
78
# File 'lib/hyrax.rb', line 72

def self.config(&block)
  @config ||= Hyrax::Configuration.new

  yield @config if block

  @config
end

.custom_queriesObject

The custom queries common to Hyrax


140
141
142
# File 'lib/hyrax.rb', line 140

def self.custom_queries
  query_service.custom_queries
end

.FormFields(schema_name, **options) ⇒ Object

Parameters:

  • schema_name (Symbol)

Since:

  • 3.0.0


10
11
12
# File 'lib/hyrax/form_fields.rb', line 10

def self.FormFields(schema_name, **options)
  Hyrax::FormFields.new(schema_name, **options)
end

.GlobalID(input) ⇒ GlobalID


53
54
55
56
57
58
59
60
61
62
# File 'lib/hyrax.rb', line 53

def self.GlobalID(input) # rubocop:disable Naming/MethodName
  case input
  when Valkyrie::Resource
    return input.to_global_id if input.respond_to?(:to_global_id)

    ValkyrieGlobalIdProxy.new(resource: input).to_global_id
  else
    input.to_global_id if input.respond_to?(:to_global_id)
  end
end

.index_adapterValkyrie::IndexingAdapter


92
93
94
# File 'lib/hyrax.rb', line 92

def self.index_adapter
  config.index_adapter
end

.Indexer(schema_name, index_loader: SimpleSchemaLoader.new) ⇒ Module

Build an indexer module from a schema. Generates custom indexer behavior from rules provided by `index_loader`.

Examples:

building a module as a mixin


class MyIndexer < Hyrax::ValkyrieIndexer
  include Hyrax::Indexer(:core_metadata)
end

Parameters:

  • schema_name (Symbol)
  • index_loader (#index_rule_for) (defaults to: SimpleSchemaLoader.new)

Returns:

  • (Module)

Since:

  • 3.0.0


22
23
24
# File 'lib/hyrax/indexer.rb', line 22

def self.Indexer(schema_name, index_loader: SimpleSchemaLoader.new)
  Indexer.new(index_loader.index_rules_for(schema: schema_name))
end

.loggerLogger

Returns:

  • (Logger)

82
83
84
# File 'lib/hyrax.rb', line 82

def self.logger
  @logger ||= Valkyrie.logger
end

.metadata_adapterObject

Note:

always use this method to retrieve the metadata adapter when data interoperability with Hyrax is required

The Valkyrie metadata adapter used for PCDM models throughout Hyrax


116
117
118
# File 'lib/hyrax.rb', line 116

def self.
  Valkyrie.config.
end

.persisterObject

Note:

always use this method to retrieve the persister when data interoperability with Hyrax is required

The Valkyrie persister used for PCDM models throughout Hyrax


107
108
109
# File 'lib/hyrax.rb', line 107

def self.persister
  .persister
end

.primary_work_typeObject


86
87
88
# File 'lib/hyrax.rb', line 86

def self.primary_work_type
  config.curation_concerns.first
end

.publisherDry::Events::Publisher

Returns:

  • (Dry::Events::Publisher)

98
99
100
# File 'lib/hyrax.rb', line 98

def self.publisher
  config.publisher
end

.query_serviceObject

Note:

always use this method to retrieve the query service when data interoperability with Hyrax is required

The Valkyrie query service used for PCDM files throughout Hyrax


134
135
136
# File 'lib/hyrax.rb', line 134

def self.query_service
  .query_service
end

.Schema(schema_name, **options) ⇒ Module

Note:

`Valkyrie::Resources`/`Hyrax::Resources` are not required to use this

Builds a schema module for a Valkyrie resource. The schema itself is resolved by schema loader, which must respond to `#attributes_for(schema: :name)` with a hash from attribute names to `Dry::Type` types.

For the default schema loader, configuration is loaded from `config/metadata/}.yaml`. Custom schema loaders can be provided for other types.

interface, and may define custom attributes using the base `Valkyrie::Resource.attribute` interface. This mechanism is provided to allow schemas to be defined in a unified way that don't require programmer intervention (“configurable schemas”). While the default usage defines schemas in application configuration, they could also be held in repository storage, an external schema service, etc… by using a custom schema loader.

Examples:

class Monograph < Valkyrie::Resource
  include Hyrax::Schema(:book)
end

with a custom schema loader

class Monograph < Valkyrie::Resource
  include Hyrax::Schema(:book, schema_loader: MySchemaLoader.new)
end

Parameters:

  • schema_name (Symbol)

Returns:

  • (Module)

    a module that, when included, applies a schema to a `Valkyire::Resource`

Since:

  • 3.0.0


40
41
42
# File 'lib/hyrax/schema.rb', line 40

def self.Schema(schema_name, **options)
  Hyrax::Schema.new(schema_name, **options)
end

.storage_adapterObject

Note:

always use this method to retrieve the storage adapter when handling files that will be used by Hyrax

The Valkyrie storage_adapter used for PCDM files throughout Hyrax


125
126
127
# File 'lib/hyrax.rb', line 125

def self.storage_adapter
  Valkyrie.config.storage_adapter
end