hyrax 5.0.0.rc2 → 5.0.0.rc3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (307) hide show
  1. checksums.yaml +4 -4
  2. data/.circleci/config.yml +14 -0
  3. data/.dassie/app/listeners/hyrax_listener.rb +81 -0
  4. data/.dassie/config/environments/test.rb +0 -5
  5. data/.dassie/config/initializers/hyrax.rb +5 -0
  6. data/.dassie/config/initializers/publisher.rb +3 -0
  7. data/.dassie/config/initializers/riiif.rb +77 -0
  8. data/.gitignore +4 -0
  9. data/.koppie/.env +2 -2
  10. data/.koppie/app/forms/collection_resource_form.rb +1 -0
  11. data/.koppie/app/indexers/collection_resource_indexer.rb +1 -0
  12. data/.koppie/app/listeners/hyrax_listener.rb +81 -0
  13. data/.koppie/app/models/collection.rb +1 -1
  14. data/.koppie/app/models/collection_resource.rb +1 -0
  15. data/.koppie/config/analytics.yml +5 -5
  16. data/.koppie/config/initializers/publisher.rb +3 -0
  17. data/.koppie/config/initializers/riiif.rb +78 -0
  18. data/.koppie/config/metadata/collection_resource.yaml +8 -166
  19. data/.koppie/config/metadata/sample_metadata.yaml +4 -0
  20. data/CONTAINERS.md +39 -2
  21. data/Dockerfile +14 -11
  22. data/Gemfile +8 -7
  23. data/README.md +2 -0
  24. data/app/actors/hyrax/actors/base_actor.rb +6 -3
  25. data/app/actors/hyrax/actors/file_actor.rb +1 -1
  26. data/app/actors/hyrax/actors/lease_actor.rb +3 -6
  27. data/app/assets/javascripts/hyrax/save_work/uploaded_files.es6 +10 -2
  28. data/app/assets/stylesheets/hyrax/sidebar.scss +6 -1
  29. data/app/controllers/concerns/hyrax/collections_controller_behavior.rb +1 -1
  30. data/app/controllers/concerns/hyrax/local_file_downloads_controller_behavior.rb +12 -19
  31. data/app/controllers/concerns/hyrax/stream_file_downloads_controller_behavior.rb +54 -0
  32. data/app/controllers/concerns/hyrax/valkyrie_downloads_controller_behavior.rb +38 -9
  33. data/app/controllers/concerns/hyrax/works_controller_behavior.rb +19 -14
  34. data/app/controllers/hyrax/admin/admin_sets_controller.rb +2 -2
  35. data/app/controllers/hyrax/admin/analytics/work_reports_controller.rb +5 -5
  36. data/app/controllers/hyrax/dashboard/collections_controller.rb +2 -2
  37. data/app/controllers/hyrax/downloads_controller.rb +1 -0
  38. data/app/controllers/hyrax/file_sets_controller.rb +3 -2
  39. data/app/controllers/hyrax/my/collections_controller.rb +1 -1
  40. data/app/forms/concerns/hyrax/basic_metadata_form_fields_behavior.rb +1 -0
  41. data/app/forms/concerns/hyrax/contained_in_works_behavior.rb +24 -0
  42. data/app/forms/concerns/hyrax/deposit_agreement_behavior.rb +12 -0
  43. data/app/forms/concerns/hyrax/leaseability_behavior.rb +49 -0
  44. data/app/forms/concerns/hyrax/permission_behavior.rb +20 -0
  45. data/app/forms/hyrax/forms/administrative_set_form.rb +1 -5
  46. data/app/forms/hyrax/forms/collection_form.rb +19 -0
  47. data/app/forms/hyrax/forms/file_set_form.rb +5 -0
  48. data/app/forms/hyrax/forms/pcdm_collection_form.rb +1 -5
  49. data/app/forms/hyrax/forms/pcdm_object_form.rb +13 -22
  50. data/app/forms/hyrax/forms/resource_batch_edit_form.rb +7 -2
  51. data/app/forms/hyrax/forms/resource_form.rb +30 -100
  52. data/app/forms/hyrax/forms.rb +52 -0
  53. data/app/helpers/hyrax/hyrax_helper_behavior.rb +2 -0
  54. data/app/indexers/{hyrax → concerns/hyrax}/location_indexer.rb +1 -5
  55. data/app/indexers/{hyrax → concerns/hyrax}/permission_indexer.rb +2 -2
  56. data/app/indexers/{hyrax → concerns/hyrax}/visibility_indexer.rb +1 -1
  57. data/app/indexers/hyrax/administrative_set_indexer.rb +5 -17
  58. data/app/indexers/hyrax/indexers/administrative_set_indexer.rb +25 -0
  59. data/app/indexers/hyrax/indexers/file_set_indexer.rb +144 -0
  60. data/app/indexers/hyrax/indexers/pcdm_collection_indexer.rb +27 -0
  61. data/app/indexers/hyrax/indexers/pcdm_object_indexer.rb +72 -0
  62. data/app/indexers/hyrax/indexers/resource_indexer.rb +86 -0
  63. data/app/indexers/hyrax/indexers.rb +54 -0
  64. data/app/indexers/hyrax/pcdm_collection_indexer.rb +5 -18
  65. data/app/indexers/hyrax/valkyrie_collection_indexer.rb +6 -4
  66. data/app/indexers/hyrax/valkyrie_file_set_indexer.rb +5 -136
  67. data/app/indexers/hyrax/valkyrie_indexer.rb +8 -112
  68. data/app/indexers/hyrax/valkyrie_work_indexer.rb +5 -64
  69. data/app/indexers/hyrax/work_indexer.rb +1 -0
  70. data/app/jobs/create_work_job.rb +1 -0
  71. data/app/models/admin_set.rb +20 -1
  72. data/app/models/collection.rb +5 -0
  73. data/app/models/concerns/hyrax/ability/admin_set_ability.rb +13 -28
  74. data/app/models/concerns/hyrax/ability/collection_ability.rb +26 -28
  75. data/app/models/concerns/hyrax/ability/resource_ability.rb +19 -0
  76. data/app/models/concerns/hyrax/ability.rb +11 -9
  77. data/app/models/concerns/hyrax/collection_behavior.rb +8 -0
  78. data/app/models/concerns/hyrax/solr_document_behavior.rb +15 -5
  79. data/app/models/concerns/hyrax/work_behavior.rb +4 -0
  80. data/app/models/featured_work.rb +12 -4
  81. data/app/models/file_set.rb +5 -0
  82. data/app/models/hyrax/administrative_set.rb +1 -1
  83. data/app/models/hyrax/change_set.rb +2 -2
  84. data/app/models/hyrax/file_metadata.rb +34 -7
  85. data/app/models/hyrax/file_set.rb +2 -2
  86. data/app/models/hyrax/group.rb +9 -38
  87. data/app/models/hyrax/group_behavior.rb +58 -0
  88. data/app/models/hyrax/model_registry.rb +111 -0
  89. data/app/models/hyrax/pcdm_collection.rb +1 -7
  90. data/app/models/hyrax/resource.rb +66 -8
  91. data/app/models/hyrax/statistic.rb +1 -1
  92. data/app/models/hyrax/work.rb +1 -7
  93. data/app/presenters/hyrax/collapsable_section_presenter.rb +7 -3
  94. data/app/presenters/hyrax/file_set_presenter.rb +8 -6
  95. data/app/presenters/hyrax/lease_presenter.rb +4 -0
  96. data/app/presenters/hyrax/menu_presenter.rb +14 -2
  97. data/app/presenters/hyrax/pcdm_member_presenter_factory.rb +1 -1
  98. data/app/presenters/hyrax/version_list_presenter.rb +6 -4
  99. data/app/search_builders/hyrax/admin_set_search_builder.rb +1 -1
  100. data/app/search_builders/hyrax/catalog_search_builder.rb +2 -2
  101. data/app/search_builders/hyrax/dashboard/collections_search_builder.rb +5 -3
  102. data/app/search_builders/hyrax/exposed_models_relation.rb +1 -1
  103. data/app/search_builders/hyrax/file_set_search_builder.rb +1 -1
  104. data/app/search_builders/hyrax/filter_by_type.rb +3 -2
  105. data/app/search_builders/hyrax/member_with_files_search_builder.rb +1 -1
  106. data/app/search_builders/hyrax/my/collections_search_builder.rb +2 -2
  107. data/app/search_builders/hyrax/my/find_works_search_builder.rb +8 -3
  108. data/app/services/hyrax/access_control_list.rb +21 -4
  109. data/app/services/hyrax/action/create_valkyrie_work.rb +80 -0
  110. data/app/services/hyrax/admin_set_create_service.rb +7 -3
  111. data/app/services/hyrax/admin_set_service.rb +2 -2
  112. data/app/services/hyrax/collections/collection_member_search_service.rb +2 -0
  113. data/app/services/hyrax/collections/permissions_service.rb +27 -9
  114. data/app/services/hyrax/custom_queries/find_collections_by_type.rb +1 -1
  115. data/app/services/hyrax/custom_queries/find_file_metadata.rb +1 -1
  116. data/app/services/hyrax/custom_queries/navigators/find_files.rb +1 -1
  117. data/app/services/hyrax/custom_queries/navigators/parent_work_navigator.rb +1 -1
  118. data/app/services/hyrax/edit_permissions_service.rb +1 -1
  119. data/app/services/hyrax/embargo_manager.rb +1 -1
  120. data/app/services/hyrax/file_set_file_service.rb +21 -10
  121. data/app/services/hyrax/form_factory.rb +1 -1
  122. data/app/services/hyrax/lease_manager.rb +39 -16
  123. data/app/services/hyrax/lease_service.rb +12 -6
  124. data/app/services/hyrax/listeners/acl_index_listener.rb +1 -1
  125. data/app/services/hyrax/listeners/active_fedora_acl_index_listener.rb +1 -1
  126. data/app/services/hyrax/listeners/member_cleanup_listener.rb +15 -1
  127. data/app/services/hyrax/listeners/object_lifecycle_listener.rb +5 -1
  128. data/app/services/hyrax/listeners/trophy_cleanup_listener.rb +2 -1
  129. data/app/services/hyrax/listeners/workflow_listener.rb +13 -0
  130. data/app/services/hyrax/listeners.rb +2 -1
  131. data/app/services/hyrax/location_service.rb +3 -0
  132. data/app/services/hyrax/multiple_membership_checker.rb +1 -1
  133. data/app/services/hyrax/simple_schema_loader.rb +1 -1
  134. data/app/services/hyrax/solr_service.rb +19 -5
  135. data/app/services/hyrax/statistics/collections/over_time.rb +1 -1
  136. data/app/services/hyrax/statistics/query_service.rb +6 -0
  137. data/app/services/hyrax/valkyrie_persist_derivatives.rb +11 -4
  138. data/app/services/hyrax/valkyrie_upload.rb +1 -1
  139. data/app/services/hyrax/work_uploads_handler.rb +5 -4
  140. data/app/views/_user_util_links.html.erb +1 -1
  141. data/app/views/collections/edit_fields/_based_near.html.erb +11 -7
  142. data/app/views/hyrax/admin/admin_sets/_form_participants.html.erb +67 -67
  143. data/app/views/hyrax/admin/admin_sets/edit.html.erb +1 -1
  144. data/app/views/hyrax/admin/collection_types/_form_participants.html.erb +3 -1
  145. data/app/views/hyrax/base/_attribute_rows.html.erb +1 -0
  146. data/app/views/hyrax/base/_base_form_files_prepend.html.erb +4 -0
  147. data/app/views/hyrax/base/_form_files.html.erb +65 -64
  148. data/app/views/hyrax/base/show.html.erb +2 -3
  149. data/app/views/hyrax/collections/show.html.erb +7 -9
  150. data/app/views/hyrax/dashboard/_sidebar.html.erb +4 -3
  151. data/app/views/hyrax/dashboard/collections/_form_share_table.html.erb +2 -2
  152. data/app/views/hyrax/file_sets/media_display/_audio.html.erb +1 -1
  153. data/app/views/hyrax/file_sets/media_display/_video.html.erb +1 -1
  154. data/app/views/hyrax/my/facet.html.erb +1 -1
  155. data/app/views/layouts/_head_tag_content.html.erb +1 -0
  156. data/app/views/shared/_footer.html.erb +1 -1
  157. data/chart/hyrax/Chart.yaml +3 -3
  158. data/chart/hyrax/values.yaml +9 -1
  159. data/config/initializers/listeners.rb +1 -1
  160. data/config/locales/hyrax.de.yml +5 -0
  161. data/config/locales/hyrax.en.yml +10 -0
  162. data/config/locales/hyrax.es.yml +5 -0
  163. data/config/locales/hyrax.fr.yml +5 -0
  164. data/config/locales/hyrax.it.yml +5 -0
  165. data/config/locales/hyrax.pt-BR.yml +5 -0
  166. data/config/locales/hyrax.zh.yml +5 -0
  167. data/config/metadata/basic_metadata.yaml +1 -0
  168. data/config/metadata/core_metadata.yaml +2 -0
  169. data/config/metadata/file_set_metadata.yaml +2 -0
  170. data/docker-compose-koppie.yml +3 -3
  171. data/docker-compose-sirenia.yml +3 -3
  172. data/documentation/developing-your-hyrax-based-app.md +77 -60
  173. data/hyrax.gemspec +9 -2
  174. data/lib/generators/hyrax/collection_resource/templates/collection_indexer.rb.erb +1 -1
  175. data/lib/generators/hyrax/config_generator.rb +12 -0
  176. data/lib/generators/hyrax/install_generator.rb +37 -7
  177. data/lib/generators/hyrax/listeners_generator.rb +18 -0
  178. data/lib/generators/hyrax/models_generator.rb +1 -10
  179. data/lib/generators/hyrax/riiif_generator.rb +6 -4
  180. data/lib/generators/hyrax/templates/.env +9 -0
  181. data/lib/generators/hyrax/templates/.lando.yml +50 -0
  182. data/lib/generators/hyrax/templates/app/listeners/hyrax_listener.rb +81 -0
  183. data/lib/generators/hyrax/templates/app/models/file_set.rb +1 -2
  184. data/lib/generators/hyrax/templates/config/initializers/1_valkyrie.rb +102 -0
  185. data/lib/generators/hyrax/templates/config/initializers/file_services.rb +6 -0
  186. data/lib/generators/hyrax/templates/config/initializers/hyrax.rb +41 -5
  187. data/lib/generators/hyrax/templates/config/initializers/publisher.rb +3 -0
  188. data/lib/generators/hyrax/templates/config/initializers/riiif.rb +77 -0
  189. data/lib/generators/hyrax/templates/config/locales/hyrax.de.yml +1 -1
  190. data/lib/generators/hyrax/templates/config/locales/hyrax.en.yml +1 -1
  191. data/lib/generators/hyrax/templates/config/locales/hyrax.es.yml +1 -1
  192. data/lib/generators/hyrax/templates/config/locales/hyrax.fr.yml +1 -1
  193. data/lib/generators/hyrax/templates/config/locales/hyrax.it.yml +1 -1
  194. data/lib/generators/hyrax/templates/config/locales/hyrax.pt-BR.yml +1 -1
  195. data/lib/generators/hyrax/templates/config/locales/hyrax.zh.yml +1 -1
  196. data/lib/generators/hyrax/templates/config/redis.yml +3 -6
  197. data/lib/generators/hyrax/templates/config/valkyrie_index.yml +4 -9
  198. data/lib/generators/hyrax/work_resource/templates/indexer.rb.erb +1 -1
  199. data/lib/hyrax/configuration.rb +95 -7
  200. data/lib/hyrax/indexer.rb +1 -1
  201. data/lib/hyrax/publisher.rb +5 -2
  202. data/lib/hyrax/resource_sync/change_list_writer.rb +1 -1
  203. data/lib/hyrax/resource_sync/resource_list_writer.rb +1 -1
  204. data/lib/hyrax/specs/capybara.rb +1 -0
  205. data/lib/hyrax/specs/shared_specs/hydra_works.rb +78 -20
  206. data/lib/hyrax/specs/shared_specs/indexers.rb +1 -1
  207. data/lib/hyrax/transactions/admin_set_destroy.rb +2 -1
  208. data/lib/hyrax/transactions/container.rb +5 -0
  209. data/lib/hyrax/transactions/steps/add_to_parent.rb +1 -0
  210. data/lib/hyrax/transactions/steps/check_for_default_admin_set.rb +32 -0
  211. data/lib/hyrax/transactions/steps/check_for_empty_admin_set.rb +1 -1
  212. data/lib/hyrax/transactions/steps/save.rb +2 -1
  213. data/lib/hyrax/transactions/steps/set_user_as_creator.rb +1 -1
  214. data/lib/hyrax/transactions/steps/update_work_members.rb +2 -0
  215. data/lib/hyrax/version.rb +1 -1
  216. data/lib/hyrax.rb +1 -0
  217. data/lib/tasks/embargo_lease.rake +1 -0
  218. data/lib/valkyrie/indexing/solr/indexing_adapter.rb +21 -7
  219. data/lib/wings/active_fedora_converter/default_work.rb +4 -5
  220. data/lib/wings/active_fedora_converter/file_metadata_node.rb +1 -1
  221. data/lib/wings/model_registry.rb +8 -0
  222. data/lib/wings/model_transformer.rb +19 -2
  223. data/lib/wings/orm_converter.rb +4 -0
  224. data/lib/wings/services/custom_queries/find_ids_by_model.rb +2 -2
  225. data/lib/wings/valkyrie/query_service.rb +5 -2
  226. data/lib/wings.rb +3 -0
  227. data/spec/factories/access_control.rb +12 -0
  228. data/spec/factories/admin_sets.rb +32 -0
  229. data/spec/factories/admin_sets_lw.rb +222 -0
  230. data/spec/factories/administrative_sets.rb +79 -0
  231. data/spec/factories/api_items.rb +92 -0
  232. data/spec/factories/collection_branding_infos.rb +12 -0
  233. data/spec/factories/collection_type_participants.rb +9 -0
  234. data/spec/factories/collection_types.rb +139 -0
  235. data/spec/factories/collections.rb +282 -0
  236. data/spec/factories/collections_factory.rb +107 -0
  237. data/spec/factories/content_blocks.rb +5 -0
  238. data/spec/factories/counter_metrics.rb +12 -0
  239. data/spec/factories/featured_works.rb +5 -0
  240. data/spec/factories/file_sets.rb +45 -0
  241. data/spec/factories/generic_works.rb +200 -0
  242. data/spec/factories/hyrax_collection.rb +92 -0
  243. data/spec/factories/hyrax_default_admin_set.rb +7 -0
  244. data/spec/factories/hyrax_embargo.rb +18 -0
  245. data/spec/factories/hyrax_file_metadata.rb +92 -0
  246. data/spec/factories/hyrax_file_set.rb +129 -0
  247. data/spec/factories/hyrax_lease.rb +18 -0
  248. data/spec/factories/hyrax_resource.rb +15 -0
  249. data/spec/factories/hyrax_work.rb +221 -0
  250. data/spec/factories/object_id.rb +7 -0
  251. data/spec/factories/operations.rb +22 -0
  252. data/spec/factories/permission.rb +7 -0
  253. data/spec/factories/permission_template_accesses.rb +17 -0
  254. data/spec/factories/permission_templates.rb +111 -0
  255. data/spec/factories/proxy_deposit_requests.rb +7 -0
  256. data/spec/factories/single_use_links.rb +14 -0
  257. data/spec/factories/sipity_entities.rb +17 -0
  258. data/spec/factories/uploaded_files.rb +11 -0
  259. data/spec/factories/users.rb +52 -0
  260. data/spec/factories/workflow_actions.rb +7 -0
  261. data/spec/factories/workflow_states.rb +7 -0
  262. data/spec/factories/workflows.rb +7 -0
  263. data/spec/support/book_resource.rb +36 -0
  264. data/spec/support/can_can_overrides.rb +43 -0
  265. data/spec/support/clean_solr.rb +7 -0
  266. data/spec/support/controller_level_helpers.rb +27 -0
  267. data/spec/support/factory_helpers.rb +94 -0
  268. data/spec/support/fakes/fake_actor.rb +22 -0
  269. data/spec/support/fakes/fake_authority.rb +14 -0
  270. data/spec/support/fakes/fake_search_builder_scope.rb +44 -0
  271. data/spec/support/fakes/indexing_adapter.rb +17 -0
  272. data/spec/support/fakes/test_hydra_group_service.rb +55 -0
  273. data/spec/support/features/batch_edit_actions.rb +37 -0
  274. data/spec/support/features/session_helpers.rb +15 -0
  275. data/spec/support/features/workflow.rb +10 -0
  276. data/spec/support/features.rb +11 -0
  277. data/spec/support/form_with_validations.rb +15 -0
  278. data/spec/support/input_support.rb +12 -0
  279. data/spec/support/logging_formatter.rb +67 -0
  280. data/spec/support/matchers/api_responses.rb +27 -0
  281. data/spec/support/matchers/collection_type_property_matchers.rb +30 -0
  282. data/spec/support/matchers/embargo.rb +9 -0
  283. data/spec/support/matchers/lease.rb +9 -0
  284. data/spec/support/matchers/match_valkyrie_ids_with_af_ids.rb +12 -0
  285. data/spec/support/matchers/pcdm_matchers.rb +34 -0
  286. data/spec/support/matchers/permission.rb +31 -0
  287. data/spec/support/matchers/response_matchers.rb +8 -0
  288. data/spec/support/optional_example.rb +17 -0
  289. data/spec/support/rake.rb +42 -0
  290. data/spec/support/selectors.rb +112 -0
  291. data/spec/support/shared_examples_for_collection_presenter.rb +44 -0
  292. data/spec/support/simple_work.rb +28 -0
  293. data/spec/support/spec_statistic.rb +24 -0
  294. data/spec/support/speedup.rb +7 -0
  295. data/spec/support/statistic_helper.rb +10 -0
  296. data/spec/support/valkyrie_indexing.rb +2 -0
  297. data/spec/support/wings_models.rb +9 -0
  298. data/template.rb +1 -3
  299. metadata +112 -30
  300. data/app/indexers/hyrax/resource_indexer.rb +0 -15
  301. data/app/models/concerns/hyrax/riiif_file.rb +0 -30
  302. data/app/services/hyrax/characterization/model_wrapper.rb +0 -0
  303. data/app/services/hyrax/custom_queries/find_by_collection_type.rb +0 -0
  304. data/app/services/hyrax/query_service.rb +0 -0
  305. data/app/services/hyrax/riiif_file_resolver.rb +0 -50
  306. data/lib/hyrax/specs/disable_animations_in_test_environment.rb +0 -53
  307. /data/app/indexers/{hyrax → concerns/hyrax}/thumbnail_indexer.rb +0 -0
@@ -32,26 +32,39 @@ module Hyrax
32
32
  # Constants for PCDM Use URIs; use these constants in place of hard-coded
33
33
  # URIs in the `::Valkyrie::Vocab::PCDMUse` vocabulary.
34
34
  module Use
35
- ORIGINAL_FILE = ::Valkyrie::Vocab::PCDMUse.OriginalFile
36
35
  EXTRACTED_TEXT = ::Valkyrie::Vocab::PCDMUse.ExtractedText
37
- THUMBNAIL = ::Valkyrie::Vocab::PCDMUse.ThumbnailImage
36
+ INTERMEDIATE_FILE = ::Valkyrie::Vocab::PCDMUse.IntermediateFile
37
+ ORIGINAL_FILE = ::Valkyrie::Vocab::PCDMUse.OriginalFile
38
+ PRESERVATION_FILE = ::Valkyrie::Vocab::PCDMUse.PreservationFile
38
39
  SERVICE_FILE = ::Valkyrie::Vocab::PCDMUse.ServiceFile
40
+ THUMBNAIL_IMAGE = ::Valkyrie::Vocab::PCDMUse.ThumbnailImage
41
+ TRANSCRIPT = ::Valkyrie::Vocab::PCDMUse.Transcript
42
+
43
+ THUMBNAIL = ::Valkyrie::Vocab::PCDMUse.ThumbnailImage # for compatibility with earlier versions of Hyrax; prefer +THUMBNAIL_IMAGE+
39
44
 
40
45
  ##
41
46
  # @param use [RDF::URI, Symbol]
42
47
  #
43
48
  # @return [RDF::URI]
44
49
  # @raise [ArgumentError] if no use is known for the argument
45
- def uri_for(use:)
50
+ def uri_for(use:) # rubocop:disable Metrics/MethodLength
46
51
  case use
47
52
  when RDF::URI
48
53
  use
49
- when :original_file
50
- ORIGINAL_FILE
51
54
  when :extracted_file
52
55
  EXTRACTED_TEXT
56
+ when :intermediate_file
57
+ INTERMEDIATE_FILE
58
+ when :original_file
59
+ ORIGINAL_FILE
60
+ when :preservation_file
61
+ PRESERVATION_FILE
62
+ when :service_file
63
+ SERVICE_FILE
53
64
  when :thumbnail_file
54
- THUMBNAIL
65
+ THUMBNAIL_IMAGE
66
+ when :transcript_file
67
+ TRANSCRIPT
55
68
  else
56
69
  raise ArgumentError, "No PCDM use is recognized for #{use}"
57
70
  end
@@ -127,6 +140,14 @@ module Hyrax
127
140
  # attributes set by fits for video
128
141
  attribute :aspect_ratio, ::Valkyrie::Types::Set
129
142
 
143
+ class << self
144
+ ##
145
+ # @return [String]
146
+ def to_rdf_representation
147
+ name
148
+ end
149
+ end
150
+
130
151
  ##
131
152
  # @return [Boolean]
132
153
  def original_file?
@@ -136,7 +157,7 @@ module Hyrax
136
157
  ##
137
158
  # @return [Boolean]
138
159
  def thumbnail_file?
139
- pcdm_use.include?(Use::THUMBNAIL)
160
+ pcdm_use.include?(Use::THUMBNAIL_IMAGE)
140
161
  end
141
162
 
142
163
  ##
@@ -145,6 +166,12 @@ module Hyrax
145
166
  pcdm_use.include?(Use::EXTRACTED_TEXT)
146
167
  end
147
168
 
169
+ ##
170
+ # @return [String]
171
+ def to_rdf_representation
172
+ self.class.to_rdf_representation
173
+ end
174
+
148
175
  def title
149
176
  label
150
177
  end
@@ -114,13 +114,13 @@ module Hyrax
114
114
 
115
115
  ##
116
116
  # @return [Boolean] true
117
- def pcdm_object?
117
+ def self.file_set?
118
118
  true
119
119
  end
120
120
 
121
121
  ##
122
122
  # @return [Boolean] true
123
- def file_set?
123
+ def self.pcdm_object?
124
124
  true
125
125
  end
126
126
  end
@@ -1,49 +1,20 @@
1
1
  # frozen_string_literal: true
2
+
2
3
  module Hyrax
4
+ ##
5
+ # A Plain Old Ruby Object (PORO) representing a named group.
6
+ #
7
+ # In Hyku, we replace the PORO with an Application Record. But there is significant duplication
8
+ # of logic.
9
+ #
10
+ # @see Hyrax::GroupBehavior
3
11
  class Group
4
- DEFAULT_NAME_PREFIX = 'group/'
5
-
6
- def self.name_prefix
7
- DEFAULT_NAME_PREFIX
8
- end
9
-
10
- ##
11
- # @return [Hyrax::Group]
12
- def self.from_agent_key(key)
13
- new(key.delete_prefix(name_prefix))
14
- end
12
+ include Hyrax::GroupBehavior
15
13
 
16
14
  def initialize(name)
17
15
  @name = name
18
16
  end
19
17
 
20
18
  attr_reader :name
21
-
22
- ##
23
- # @return [Boolean]
24
- def ==(other)
25
- other.class == self.class && other.name == name
26
- end
27
-
28
- ##
29
- # @return [String] a local identifier for this group; for use (e.g.) in ACL
30
- # data
31
- def agent_key
32
- self.class.name_prefix + name
33
- end
34
-
35
- def to_sipity_agent
36
- sipity_agent || create_sipity_agent!
37
- end
38
-
39
- private
40
-
41
- def sipity_agent
42
- Sipity::Agent.find_by(proxy_for_id: name, proxy_for_type: self.class.name)
43
- end
44
-
45
- def create_sipity_agent!
46
- Sipity::Agent.create!(proxy_for_id: name, proxy_for_type: self.class.name)
47
- end
48
19
  end
49
20
  end
@@ -0,0 +1,58 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Hyrax
4
+ ##
5
+ # An {ActiveSupport::Concern} module that contains the {Hyrax::Group} logic. It is extracted to a
6
+ # behavior because downstream Hyku has a Hyrax::Group that inherits from ApplicationRecord. In
7
+ # other words it eschews the plain old Ruby object (PORO). However, both Hyku and Hyrax's
8
+ # {Hyrax::Group} both have notable amounts of duplicated logic.
9
+ #
10
+ # @see Hyrax::Group
11
+ module GroupBehavior
12
+ extend ActiveSupport::Concern
13
+
14
+ DEFAULT_NAME_PREFIX = 'group/'
15
+
16
+ class_methods do
17
+ ##
18
+ # @return [String]
19
+ # @see DEFAULT_NAME_PREFIX
20
+ def name_prefix
21
+ DEFAULT_NAME_PREFIX
22
+ end
23
+
24
+ ##
25
+ # @return [Hyrax::Group]
26
+ def from_agent_key(key)
27
+ new(key.delete_prefix(name_prefix))
28
+ end
29
+ end
30
+
31
+ ##
32
+ # @return [Boolean]
33
+ def ==(other)
34
+ other.class == self.class && other.name == name
35
+ end
36
+
37
+ ##
38
+ # @return [String] a local identifier for this group; for use (e.g.) in ACL
39
+ # data
40
+ def agent_key
41
+ self.class.name_prefix + name
42
+ end
43
+
44
+ def to_sipity_agent
45
+ sipity_agent || create_sipity_agent!
46
+ end
47
+
48
+ private
49
+
50
+ def sipity_agent
51
+ Sipity::Agent.find_by(proxy_for_id: name, proxy_for_type: self.class.name)
52
+ end
53
+
54
+ def create_sipity_agent!
55
+ Sipity::Agent.create!(proxy_for_id: name, proxy_for_type: self.class.name)
56
+ end
57
+ end
58
+ end
@@ -0,0 +1,111 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Hyrax
4
+ ##
5
+ # There are four conceptual high-level models for the metadata modeling:
6
+ #
7
+ # - AdminSet :: Where things are "physically" stored.
8
+ # - Collection :: What things "logically" belong to.
9
+ # - Work :: What the thing is about; these are often sub-divided into different work types
10
+ # (e.g. an Article, a Monograph, etc.)
11
+ # - FileSet :: Artifacts that further describe the thing.
12
+ #
13
+ # The purpose of this module is to provide an overview and map of the modeling concepts. This is
14
+ # envisioned as a module to interrogate to see how Hyrax conceptually organizes your models.
15
+ #
16
+ # For each of the above high-level models the {Hyrax::ModelRegistry} implements two methods:
17
+ #
18
+ # - <model_type>_classes :: These are the Ruby constants that represent the conceptual models.
19
+ # - <model_type>_rdf_representations :: These are the stored strings that help us describe what #
20
+ # - the data models. Very useful in our Solr queries when we want to filter/query on the
21
+ # - "has_model_ssim" attribute.
22
+ #
23
+ # Consider that an {AdminSet} and a {Hyrax::AdministrativeSet} conceptually model the same thing;
24
+ # the latter implements via Valkyrie and the former via ActiveFedora.
25
+ #
26
+ # @note Due to the shift from ActiveFedora to Valkyrie, we are at a crossroads where we might have
27
+ # multiple models for the versions: an ActiveFedora AdminSet and a Valkyrie AdminSet.
28
+ class ModelRegistry
29
+ ##
30
+ # @return [Array<String>]
31
+ def self.admin_set_class_names
32
+ ["::AdminSet", "::Hyrax::AdministrativeSet", Hyrax.config.admin_set_model].uniq
33
+ end
34
+
35
+ ##
36
+ # @return [Array<Class>]
37
+ def self.admin_set_classes
38
+ classes_from(admin_set_class_names)
39
+ end
40
+
41
+ ##
42
+ # @return [Array<String>]
43
+ def self.admin_set_rdf_representations
44
+ rdf_representations_from(admin_set_classes)
45
+ end
46
+
47
+ ##
48
+ # @return [Array<String>]
49
+ def self.collection_class_names
50
+ ["::Collection", "::Hyrax::PcdmCollection", Hyrax.config.collection_model].uniq
51
+ end
52
+
53
+ ##
54
+ # @return [Array<String>]
55
+ def self.collection_classes
56
+ classes_from(collection_class_names)
57
+ end
58
+
59
+ def self.collection_rdf_representations
60
+ rdf_representations_from(collection_classes)
61
+ end
62
+
63
+ def self.collection_has_model_ssim
64
+ collection_rdf_representations
65
+ end
66
+
67
+ ##
68
+ # @return [Array<String>]
69
+ def self.file_set_class_names
70
+ ["::FileSet", "::Hyrax::FileSet", Hyrax.config.file_set_model].uniq
71
+ end
72
+
73
+ def self.file_set_classes
74
+ classes_from(file_set_class_names)
75
+ end
76
+
77
+ ##
78
+ # @return [Array<String>]
79
+ def self.file_set_rdf_representations
80
+ rdf_representations_from(file_set_classes)
81
+ end
82
+
83
+ ##
84
+ # @return [Array<Class>]
85
+ #
86
+ # @todo Consider the Wings::ModelRegistry and how we perform mappings.
87
+ def self.work_class_names
88
+ Hyrax.config.registered_curation_concern_types
89
+ end
90
+
91
+ def self.work_classes
92
+ classes_from(work_class_names)
93
+ end
94
+
95
+ ##
96
+ # @return [Array<String>]
97
+ def self.work_rdf_representations
98
+ rdf_representations_from(work_classes)
99
+ end
100
+
101
+ def self.classes_from(strings)
102
+ strings.map(&:safe_constantize).flatten.uniq
103
+ end
104
+ private_class_method :classes_from
105
+
106
+ def self.rdf_representations_from(klasses)
107
+ klasses.map { |klass| klass.respond_to?(:to_rdf_representation) ? klass.to_rdf_representation : klass.name }.uniq
108
+ end
109
+ private_class_method :rdf_representations_from
110
+ end
111
+ end
@@ -56,13 +56,7 @@ module Hyrax
56
56
 
57
57
  ##
58
58
  # @return [Boolean] true
59
- def collection?
60
- true
61
- end
62
-
63
- ##
64
- # @return [Boolean] true
65
- def pcdm_object?
59
+ def self.pcdm_collection?
66
60
  true
67
61
  end
68
62
 
@@ -35,8 +35,8 @@ module Hyrax
35
35
  include Hyrax::WithEvents
36
36
 
37
37
  attribute :alternate_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID)
38
- attribute :embargo_id, Valkyrie::Types::ID
39
- attribute :lease_id, Valkyrie::Types::ID
38
+ attribute :embargo_id, Valkyrie::Types::Params::ID
39
+ attribute :lease_id, Valkyrie::Types::Params::ID
40
40
 
41
41
  delegate :edit_groups, :edit_groups=,
42
42
  :edit_users, :edit_users=,
@@ -50,6 +50,50 @@ module Hyrax
50
50
  I18n.translate("hyrax.models.#{model_name.i18n_key}", default: model_name.human)
51
51
  end
52
52
 
53
+ ##
54
+ # @return [Boolean]
55
+ def collection?
56
+ pcdm_collection?
57
+ end
58
+
59
+ ##
60
+ # @return [Boolean]
61
+ def file?
62
+ false
63
+ end
64
+
65
+ ##
66
+ # @return [Boolean]
67
+ def file_set?
68
+ false
69
+ end
70
+
71
+ ##
72
+ # @return [Boolean]
73
+ def pcdm_collection?
74
+ false
75
+ end
76
+
77
+ ##
78
+ # @return [Boolean]
79
+ def pcdm_object?
80
+ false
81
+ end
82
+
83
+ ##
84
+ # Works are PCDM Objects which are not File Sets.
85
+ #
86
+ # @return [Boolean]
87
+ def work?
88
+ pcdm_object? && !file_set?
89
+ end
90
+
91
+ ##
92
+ # @return [String]
93
+ def to_rdf_representation
94
+ name
95
+ end
96
+
53
97
  private
54
98
 
55
99
  ##
@@ -64,35 +108,49 @@ module Hyrax
64
108
  ##
65
109
  # @return [Boolean]
66
110
  def collection?
67
- false
111
+ self.class.collection?
68
112
  end
69
113
 
70
114
  ##
71
115
  # @return [Boolean]
72
116
  def file?
73
- false
117
+ self.class.file?
74
118
  end
75
119
 
76
120
  ##
77
121
  # @return [Boolean]
78
122
  def file_set?
79
- false
123
+ self.class.file_set?
124
+ end
125
+
126
+ ##
127
+ # @return [Boolean]
128
+ def pcdm_collection?
129
+ self.class.pcdm_collection?
80
130
  end
81
131
 
82
132
  ##
83
133
  # @return [Boolean]
84
134
  def pcdm_object?
85
- false
135
+ self.class.pcdm_object?
136
+ end
137
+
138
+ ##
139
+ # @return [String]
140
+ def to_rdf_representation
141
+ self.class.to_rdf_representation
86
142
  end
87
143
 
88
144
  ##
145
+ # Works are PCDM Objects which are not File Sets.
146
+ #
89
147
  # @return [Boolean]
90
148
  def work?
91
- false
149
+ self.class.work?
92
150
  end
93
151
 
94
152
  def ==(other)
95
- attributes.except(:created_at, :updated_at) == other.attributes.except(:created_at, :updated_at)
153
+ attributes.except(:created_at, :updated_at) == other.attributes.except(:created_at, :updated_at) if other.respond_to?(:attributes)
96
154
  end
97
155
 
98
156
  def permission_manager
@@ -43,7 +43,7 @@ module Hyrax
43
43
 
44
44
  def query_works(query)
45
45
  models = Hyrax.config.curation_concerns.map { |m| "\"#{m}\"" }
46
- ActiveFedora::SolrService.query("has_model_ssim:(#{models.join(' OR ')})", fl: query, rows: 100_000)
46
+ Hyrax::SolrService.query("has_model_ssim:(#{models.join(' OR ')})", fl: query, rows: 100_000)
47
47
  end
48
48
 
49
49
  def work_types
@@ -108,13 +108,7 @@ module Hyrax
108
108
 
109
109
  ##
110
110
  # @return [Boolean] true
111
- def pcdm_object?
112
- true
113
- end
114
-
115
- ##
116
- # @return [Boolean] true
117
- def work?
111
+ def self.pcdm_object?
118
112
  true
119
113
  end
120
114
  end
@@ -2,15 +2,18 @@
2
2
  module Hyrax
3
3
  # Draws a collapsable list widget using the Bootstrap 3 / Collapse.js plugin
4
4
  class CollapsableSectionPresenter
5
- def initialize(view_context:, text:, id:, icon_class:, open:)
5
+ # rubocop:disable Metrics/ParameterLists
6
+ def initialize(view_context:, text:, id:, icon_class:, open:, title: nil)
6
7
  @view_context = view_context
7
8
  @text = text
8
9
  @id = id
9
10
  @icon_class = icon_class
10
11
  @open = open
12
+ @title = title
11
13
  end
14
+ # rubocop:enable Metrics/ParameterLists
12
15
 
13
- attr_reader :view_context, :text, :id, :icon_class, :open
16
+ attr_reader :view_context, :text, :id, :icon_class, :open, :title
14
17
  delegate :content_tag, :safe_join, :tag, to: :view_context
15
18
 
16
19
  def render(&block)
@@ -26,7 +29,8 @@ module Hyrax
26
29
  href: "##{id}",
27
30
  onclick: "toggleCollapse(this)",
28
31
  'aria-expanded' => open,
29
- 'aria-controls' => id) do
32
+ 'aria-controls' => id,
33
+ title: title) do
30
34
  safe_join([tag.span('', class: icon_class, 'aria-hidden': true),
31
35
  tag.span(text)], ' ')
32
36
  end
@@ -118,13 +118,15 @@ module Hyrax
118
118
  end
119
119
 
120
120
  def fetch_parent_presenter
121
- ids = Hyrax::SolrService.query("{!field f=member_ids_ssim}#{id}", fl: Hyrax.config.id_field)
121
+ ids = Hyrax::SolrService.query("{!field f=member_ids_ssim}#{id}", fl: Hyrax.config.id_field, rows: 1)
122
122
  .map { |x| x.fetch(Hyrax.config.id_field) }
123
- Hyrax.logger.warn("Couldn't find a parent work for FileSet: #{id}.") if ids.empty?
124
- ids.each do |id|
125
- doc = ::SolrDocument.find(id)
126
- next if current_ability.can?(:edit, doc)
127
- raise WorkflowAuthorizationException if doc.suppressed? && current_ability.can?(:read, doc)
123
+ if ids.empty?
124
+ Hyrax.logger.warn("Couldn't find a parent work for FileSet: #{id}.")
125
+ else
126
+ doc = ::SolrDocument.find(ids.first)
127
+ unless current_ability.can?(:edit, doc)
128
+ raise WorkflowAuthorizationException if doc.suppressed? && current_ability.can?(:read, doc)
129
+ end
128
130
  end
129
131
  Hyrax::PresenterFactory.build_for(ids: ids,
130
132
  presenter_class: WorkShowPresenter,
@@ -27,5 +27,9 @@ module Hyrax
27
27
  def lease_history
28
28
  solr_document['lease_history_ssim']
29
29
  end
30
+
31
+ def enforced?
32
+ solr_document.lease_enforced?
33
+ end
30
34
  end
31
35
  end
@@ -11,10 +11,20 @@ module Hyrax
11
11
  delegate :controller, :controller_name, :action_name, :content_tag,
12
12
  :current_page?, :link_to, :can?, :tag, to: :view_context
13
13
 
14
+ ##
15
+ # @!group Class Attributes
16
+ #
17
+ # @!attribute section_controller_names [r|w]
18
+ # @return [Array<String>]
19
+ # @see #settings_section?
20
+ class_attribute :section_controller_names, default: %w[appearances content_blocks features pages collection_types]
21
+ # @!endgroup Class Attributes
22
+ ##
23
+
14
24
  # Returns true if the current controller happens to be one of the controllers that deals
15
25
  # with settings. This is used to keep the parent section on the sidebar open.
16
26
  def settings_section?
17
- %w[appearances content_blocks features pages collection_types].include?(controller_name)
27
+ section_controller_names.include?(controller_name)
18
28
  end
19
29
 
20
30
  # @param options [Hash, String] a hash or string representing the path. Hash is prefered as it
@@ -47,12 +57,14 @@ module Hyrax
47
57
  %w[work_reports collection_reports].include?(controller_name)
48
58
  end
49
59
 
60
+ ##
50
61
  # Draw a collaspable menu section. The passed block should contain <li> items.
51
- def collapsable_section(text, id:, icon_class:, open:, &block)
62
+ def collapsable_section(text, id:, icon_class:, open:, title: nil, &block)
52
63
  CollapsableSectionPresenter.new(view_context: view_context,
53
64
  text: text,
54
65
  id: id,
55
66
  icon_class: icon_class,
67
+ title: title,
56
68
  open: open).render(&block)
57
69
  end
58
70
 
@@ -97,7 +97,7 @@ module Hyrax
97
97
  # @return
98
98
  def presenter_for(document:, ability:)
99
99
  case document['has_model_ssim'].first
100
- when Hyrax::FileSet.name, ::FileSet.name # ActiveFedora FileSet within a Valkyrie Resource
100
+ when *Hyrax::ModelRegistry.file_set_rdf_representations
101
101
  Hyrax::FileSetPresenter.new(document, ability)
102
102
  else
103
103
  Hyrax::WorkShowPresenter.new(document, ability)
@@ -19,13 +19,15 @@ module Hyrax
19
19
  # @return [Hyrax::VersionListPresenter] an enumerable of presenters for the
20
20
  # relevant file versions.
21
21
  #
22
- # @raise [ArgumentError] if we can't build an enu
23
- def self.for(file_set:)
24
- original_file = if file_set.respond_to?(:original_file)
22
+ # @raise [ArgumentError] if we can't build an enumerable
23
+ def self.for(file_set:, file_service: Hyrax.config.file_set_file_service)
24
+ original_file = case file_set
25
+ when ActiveFedora::Base
25
26
  file_set.original_file
26
27
  else
27
- Hyrax::FileSetFileService.new(file_set: file_set).original_file
28
+ file_service.new(file_set: file_set).primary_file
28
29
  end
30
+
29
31
  new(Hyrax::VersioningService.new(resource: original_file))
30
32
  rescue NoMethodError
31
33
  raise ArgumentError
@@ -14,7 +14,7 @@ module Hyrax
14
14
 
15
15
  # This overrides the models in FilterByType
16
16
  def models
17
- [::AdminSet, Hyrax::AdministrativeSet]
17
+ Hyrax::ModelRegistry.admin_set_classes
18
18
  end
19
19
 
20
20
  # Overrides Hydra::AccessControlsEnforcement
@@ -78,8 +78,8 @@ class Hyrax::CatalogSearchBuilder < Hyrax::SearchBuilder
78
78
  "{!dismax v=$user_query}"
79
79
  end
80
80
 
81
- # join from file id to work relationship solrized file_set_ids_ssim
81
+ # join from file id to work relationship solrized member_ids_ssim
82
82
  def join_for_works_from_files
83
- "{!join from=#{Hyrax.config.id_field} to=file_set_ids_ssim}#{dismax_query}"
83
+ "{!join from=#{Hyrax.config.id_field} to=member_ids_ssim v=has_model_ssim:*FileSet}#{dismax_query}"
84
84
  end
85
85
  end
@@ -9,7 +9,7 @@ module Hyrax
9
9
 
10
10
  # This overrides the models in FilterByType
11
11
  def models
12
- [::AdminSet, Hyrax::AdministrativeSet, ::Collection, Hyrax.config.collection_class].uniq.compact
12
+ Hyrax::ModelRegistry.admin_set_classes + Hyrax::ModelRegistry.collection_classes
13
13
  end
14
14
 
15
15
  # adds a filter to exclude collections and admin sets created by the
@@ -18,9 +18,11 @@ module Hyrax
18
18
  def show_only_managed_collections_for_non_admins(solr_parameters)
19
19
  return if current_ability.admin?
20
20
  clauses = [
21
- '-' + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(depositor: current_user_key),
22
- '-' + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(has_model: Hyrax.config.admin_set_model, creator: current_user_key)
21
+ '-' + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(depositor: current_user_key)
23
22
  ]
23
+ Hyrax::ModelRegistry.admin_set_rdf_representations.each do |has_model|
24
+ clauses += ['-' + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(has_model: has_model, creator: current_user_key)]
25
+ end
24
26
  solr_parameters[:fq] ||= []
25
27
  solr_parameters[:fq] += ["(#{clauses.join(' OR ')})"]
26
28
  end
@@ -3,7 +3,7 @@ module Hyrax
3
3
  # A relation that scopes to all user visible models (e.g. works + collections + file sets)
4
4
  class ExposedModelsRelation < AbstractTypeRelation
5
5
  def allowable_types
6
- (Hyrax.config.curation_concerns + [Hyrax.config.collection_class, ::Collection, ::FileSet]).uniq
6
+ Hyrax::ModelRegistry.work_classes + Hyrax::ModelRegistry.collection_classes + Hyrax::ModelRegistry.file_set_classes
7
7
  end
8
8
  end
9
9
  end
@@ -5,7 +5,7 @@ module Hyrax
5
5
 
6
6
  # This overrides the models in FilterByType
7
7
  def models
8
- [::FileSet, ::Hyrax::FileSet]
8
+ Hyrax::ModelRegistry.file_set_classes
9
9
  end
10
10
  end
11
11
  end