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.
Files changed (431) hide show
  1. checksums.yaml +4 -4
  2. data/.circleci/config.yml +25 -4
  3. data/.dassie/.env +5 -1
  4. data/.dassie/Gemfile +27 -42
  5. data/.dassie/Gemfile.dassie +2 -0
  6. data/.dassie/app/assets/config/manifest.js +2 -0
  7. data/.dassie/app/assets/stylesheets/hyrax.scss +1 -0
  8. data/.dassie/app/listeners/hyrax_listener.rb +81 -0
  9. data/.dassie/config/environments/test.rb +0 -5
  10. data/.dassie/config/initializers/hyrax.rb +5 -0
  11. data/.dassie/config/initializers/publisher.rb +3 -0
  12. data/.dassie/config/initializers/riiif.rb +82 -11
  13. data/.dassie/config/metadata/collection_resource.yaml +3 -0
  14. data/.dassie/config/metadata/monograph.yaml +8 -0
  15. data/.dassie/config/metadata/sample_metadata.yaml +1 -0
  16. data/.dassie/config/redis.yml +2 -0
  17. data/.dassie/db/migrate/20230725222727_create_hyrax_counter_metrics.hyrax.rb +14 -0
  18. data/.dassie/db/migrate/20230803165135_change_work_id_to_string.rb +5 -0
  19. data/.dassie/db/migrate/20230808102105_add_indices_to_hyrax_counter_metrics.hyrax.rb +8 -0
  20. data/.dassie/db/migrate/20230821153635_add_fields_to_counter_metric.rb +8 -0
  21. data/.dassie/db/schema.rb +20 -1
  22. data/.dockerignore +2 -1
  23. data/.gitignore +5 -1
  24. data/.koppie/.env +10 -4
  25. data/.koppie/Gemfile +10 -12
  26. data/.koppie/Gemfile.koppie +2 -0
  27. data/.koppie/Rakefile +0 -2
  28. data/.koppie/app/listeners/hyrax_listener.rb +81 -0
  29. data/.koppie/app/models/ability.rb +1 -5
  30. data/.koppie/app/models/collection.rb +1 -1
  31. data/.koppie/app/models/user.rb +0 -2
  32. data/.koppie/config/analytics.yml +5 -5
  33. data/.koppie/config/application.rb +2 -1
  34. data/.koppie/config/arkivo.yml +6 -0
  35. data/.koppie/config/blacklight.yml +2 -2
  36. data/.koppie/config/features.yml +2 -0
  37. data/.koppie/config/initializers/1_valkyrie.rb +29 -6
  38. data/.koppie/config/initializers/arkivo_constraint.rb +12 -0
  39. data/.koppie/config/initializers/hyrax.rb +2 -2
  40. data/.koppie/config/initializers/publisher.rb +3 -0
  41. data/.koppie/config/initializers/riiif.rb +84 -11
  42. data/.koppie/config/metadata/collection_resource.yaml +19 -1
  43. data/.koppie/config/metadata/generic_work.yaml +2 -0
  44. data/.koppie/config/metadata/monograph.yaml +10 -0
  45. data/.koppie/config/metadata/sample_metadata.yaml +4 -0
  46. data/.koppie/config/role_map.yml +3 -25
  47. data/.koppie/config/routes.rb +1 -2
  48. data/.koppie/config/solr.yml +1 -1
  49. data/.koppie/config/valkyrie_index.yml +4 -10
  50. data/.koppie/config/zotero.yml +6 -0
  51. data/.koppie/db/migrate/20230725222727_create_hyrax_counter_metrics.hyrax.rb +14 -0
  52. data/.koppie/db/migrate/20230803165135_change_work_id_to_string.rb +5 -0
  53. data/.koppie/db/schema.rb +12 -1
  54. data/CONTAINERS.md +39 -4
  55. data/Dockerfile +25 -13
  56. data/Gemfile +8 -24
  57. data/Gemfile.dassie +2 -0
  58. data/Gemfile.koppie +2 -0
  59. data/README.md +2 -1
  60. data/Rakefile +0 -11
  61. data/app/actors/hyrax/actors/base_actor.rb +6 -3
  62. data/app/actors/hyrax/actors/embargo_actor.rb +3 -6
  63. data/app/actors/hyrax/actors/file_actor.rb +1 -1
  64. data/app/actors/hyrax/actors/lease_actor.rb +3 -6
  65. data/app/assets/javascripts/hyrax/batch_select_all.js +1 -1
  66. data/app/assets/javascripts/hyrax/file_manager/member.es6 +1 -1
  67. data/app/assets/javascripts/hyrax/save_work/uploaded_files.es6 +10 -2
  68. data/app/assets/stylesheets/hyrax/_file-listing.scss +0 -2
  69. data/app/assets/stylesheets/hyrax/_work-show.scss +19 -3
  70. data/app/assets/stylesheets/hyrax/sidebar.scss +29 -1
  71. data/app/controllers/concerns/hyrax/collections_controller_behavior.rb +1 -1
  72. data/app/controllers/concerns/hyrax/embargoes_controller_behavior.rb +7 -1
  73. data/app/controllers/concerns/hyrax/leases_controller_behavior.rb +7 -1
  74. data/app/controllers/concerns/hyrax/local_file_downloads_controller_behavior.rb +12 -19
  75. data/app/controllers/concerns/hyrax/stream_file_downloads_controller_behavior.rb +54 -0
  76. data/app/controllers/concerns/hyrax/valkyrie_downloads_controller_behavior.rb +52 -18
  77. data/app/controllers/concerns/hyrax/works_controller_behavior.rb +69 -23
  78. data/app/controllers/hyrax/admin/admin_sets_controller.rb +2 -2
  79. data/app/controllers/hyrax/admin/analytics/work_reports_controller.rb +5 -5
  80. data/app/controllers/hyrax/api/items_controller.rb +2 -3
  81. data/app/controllers/hyrax/batch_edits_controller.rb +6 -6
  82. data/app/controllers/hyrax/batch_uploads_controller.rb +5 -1
  83. data/app/controllers/hyrax/dashboard/collections_controller.rb +6 -3
  84. data/app/controllers/hyrax/downloads_controller.rb +1 -0
  85. data/app/controllers/hyrax/file_sets_controller.rb +51 -7
  86. data/app/controllers/hyrax/my/collections_controller.rb +3 -1
  87. data/app/controllers/hyrax/single_use_links_viewer_controller.rb +16 -2
  88. data/app/forms/concerns/hyrax/basic_metadata_form_fields_behavior.rb +39 -0
  89. data/app/forms/concerns/hyrax/contained_in_works_behavior.rb +24 -0
  90. data/app/forms/concerns/hyrax/deposit_agreement_behavior.rb +12 -0
  91. data/app/forms/concerns/hyrax/leaseability_behavior.rb +49 -0
  92. data/app/forms/concerns/hyrax/permission_behavior.rb +20 -0
  93. data/app/forms/hyrax/forms/administrative_set_form.rb +1 -5
  94. data/app/forms/hyrax/forms/collection_form.rb +16 -12
  95. data/app/forms/hyrax/forms/dashboard/nest_collection_form.rb +0 -34
  96. data/app/forms/hyrax/forms/file_set_form.rb +7 -2
  97. data/app/forms/hyrax/forms/pcdm_collection_form.rb +1 -5
  98. data/app/forms/hyrax/forms/pcdm_object_form.rb +13 -1
  99. data/app/forms/hyrax/forms/permission_template_form.rb +0 -7
  100. data/app/forms/hyrax/forms/resource_batch_edit_form.rb +55 -22
  101. data/app/forms/hyrax/forms/resource_form.rb +31 -114
  102. data/app/forms/hyrax/forms.rb +52 -0
  103. data/app/helpers/hyrax/dashboard_helper_behavior.rb +13 -0
  104. data/app/helpers/hyrax/hyrax_helper_behavior.rb +2 -0
  105. data/app/indexers/concerns/hyrax/location_indexer.rb +25 -0
  106. data/app/indexers/{hyrax → concerns/hyrax}/permission_indexer.rb +2 -2
  107. data/app/indexers/{hyrax → concerns/hyrax}/visibility_indexer.rb +1 -1
  108. data/app/indexers/hyrax/administrative_set_indexer.rb +5 -17
  109. data/app/indexers/hyrax/indexers/administrative_set_indexer.rb +25 -0
  110. data/app/indexers/hyrax/indexers/file_set_indexer.rb +144 -0
  111. data/app/indexers/hyrax/indexers/pcdm_collection_indexer.rb +27 -0
  112. data/app/indexers/hyrax/indexers/pcdm_object_indexer.rb +72 -0
  113. data/app/indexers/hyrax/indexers/resource_indexer.rb +86 -0
  114. data/app/indexers/hyrax/indexers.rb +54 -0
  115. data/app/indexers/hyrax/pcdm_collection_indexer.rb +5 -26
  116. data/app/indexers/hyrax/valkyrie_collection_indexer.rb +6 -4
  117. data/app/indexers/hyrax/valkyrie_file_set_indexer.rb +5 -141
  118. data/app/indexers/hyrax/valkyrie_indexer.rb +8 -112
  119. data/app/indexers/hyrax/valkyrie_work_indexer.rb +5 -63
  120. data/app/indexers/hyrax/work_indexer.rb +1 -0
  121. data/app/inputs/controlled_vocabulary_input.rb +1 -1
  122. data/app/jobs/characterize_job.rb +1 -1
  123. data/app/jobs/create_work_job.rb +37 -4
  124. data/app/jobs/valkyrie_characterization_job.rb +9 -0
  125. data/app/jobs/valkyrie_ingest_job.rb +1 -3
  126. data/app/models/admin_set.rb +20 -1
  127. data/app/models/collection.rb +5 -0
  128. data/app/models/collection_branding_info.rb +2 -9
  129. data/app/models/concerns/hyrax/ability/admin_set_ability.rb +13 -28
  130. data/app/models/concerns/hyrax/ability/collection_ability.rb +26 -28
  131. data/app/models/concerns/hyrax/ability/resource_ability.rb +19 -0
  132. data/app/models/concerns/hyrax/ability.rb +12 -9
  133. data/app/models/concerns/hyrax/collection_behavior.rb +12 -12
  134. data/app/models/concerns/hyrax/solr_document_behavior.rb +33 -6
  135. data/app/models/concerns/hyrax/work_behavior.rb +4 -0
  136. data/app/models/featured_work.rb +12 -4
  137. data/app/models/file_set.rb +5 -0
  138. data/app/models/hyrax/administrative_set.rb +1 -1
  139. data/app/models/hyrax/change_set.rb +2 -2
  140. data/app/models/hyrax/counter_metric.rb +7 -0
  141. data/app/models/hyrax/file_metadata.rb +37 -9
  142. data/app/models/hyrax/file_set.rb +77 -24
  143. data/app/models/hyrax/group.rb +9 -38
  144. data/app/models/hyrax/group_behavior.rb +58 -0
  145. data/app/models/hyrax/model_registry.rb +111 -0
  146. data/app/models/hyrax/orcid_validator.rb +0 -6
  147. data/app/models/hyrax/pcdm_collection.rb +1 -7
  148. data/app/models/hyrax/resource.rb +66 -8
  149. data/app/models/hyrax/statistic.rb +1 -1
  150. data/app/models/hyrax/work.rb +3 -12
  151. data/app/presenters/hyrax/collapsable_section_presenter.rb +7 -3
  152. data/app/presenters/hyrax/collection_presenter.rb +0 -17
  153. data/app/presenters/hyrax/embargo_presenter.rb +4 -0
  154. data/app/presenters/hyrax/file_set_presenter.rb +8 -6
  155. data/app/presenters/hyrax/lease_presenter.rb +4 -0
  156. data/app/presenters/hyrax/menu_presenter.rb +14 -2
  157. data/app/presenters/hyrax/pcdm_member_presenter_factory.rb +7 -5
  158. data/app/presenters/hyrax/version_list_presenter.rb +25 -14
  159. data/app/presenters/hyrax/version_presenter.rb +19 -4
  160. data/app/search_builders/hyrax/admin_set_search_builder.rb +1 -1
  161. data/app/search_builders/hyrax/catalog_search_builder.rb +2 -2
  162. data/app/search_builders/hyrax/dashboard/collections_search_builder.rb +5 -3
  163. data/app/search_builders/hyrax/exposed_models_relation.rb +1 -1
  164. data/app/search_builders/hyrax/file_set_search_builder.rb +1 -1
  165. data/app/search_builders/hyrax/filter_by_type.rb +3 -2
  166. data/app/search_builders/hyrax/member_with_files_search_builder.rb +1 -1
  167. data/app/search_builders/hyrax/my/collections_search_builder.rb +2 -2
  168. data/app/search_builders/hyrax/my/find_works_search_builder.rb +8 -3
  169. data/app/services/hyrax/access_control_list.rb +21 -4
  170. data/app/services/hyrax/action/create_valkyrie_work.rb +80 -0
  171. data/app/services/hyrax/admin_set_create_service.rb +7 -20
  172. data/app/services/hyrax/admin_set_service.rb +2 -2
  173. data/app/services/hyrax/characterization/valkyrie_characterization_service.rb +5 -0
  174. data/app/services/hyrax/collections/collection_member_search_service.rb +2 -0
  175. data/app/services/hyrax/collections/collection_member_service.rb +1 -1
  176. data/app/services/hyrax/collections/permissions_service.rb +27 -9
  177. data/app/services/hyrax/custom_queries/find_collections_by_type.rb +1 -1
  178. data/app/services/hyrax/custom_queries/find_file_metadata.rb +1 -1
  179. data/app/services/hyrax/custom_queries/navigators/find_files.rb +1 -1
  180. data/app/services/hyrax/custom_queries/navigators/parent_work_navigator.rb +1 -1
  181. data/app/services/hyrax/edit_permissions_service.rb +1 -1
  182. data/app/services/hyrax/embargo_manager.rb +44 -17
  183. data/app/services/hyrax/embargo_service.rb +12 -10
  184. data/app/services/hyrax/file_set_derivatives_service.rb +11 -11
  185. data/app/services/hyrax/file_set_file_service.rb +21 -10
  186. data/app/services/hyrax/fixity_check_failure_service.rb +1 -1
  187. data/app/services/hyrax/form_factory.rb +1 -1
  188. data/app/services/hyrax/identifier/dispatcher.rb +9 -2
  189. data/app/services/hyrax/lease_manager.rb +39 -16
  190. data/app/services/hyrax/lease_service.rb +12 -6
  191. data/app/services/hyrax/listeners/acl_index_listener.rb +1 -1
  192. data/app/services/hyrax/listeners/active_fedora_acl_index_listener.rb +1 -1
  193. data/app/services/hyrax/listeners/file_metadata_listener.rb +14 -6
  194. data/app/services/hyrax/listeners/member_cleanup_listener.rb +12 -24
  195. data/app/services/hyrax/listeners/metadata_index_listener.rb +11 -0
  196. data/app/services/hyrax/listeners/object_lifecycle_listener.rb +5 -1
  197. data/app/services/hyrax/listeners/trophy_cleanup_listener.rb +2 -1
  198. data/app/services/hyrax/listeners/workflow_listener.rb +13 -0
  199. data/app/services/hyrax/listeners.rb +2 -1
  200. data/app/services/hyrax/location_service.rb +3 -0
  201. data/app/services/hyrax/lock_manager.rb +1 -2
  202. data/app/services/hyrax/multiple_membership_checker.rb +1 -1
  203. data/app/services/hyrax/simple_schema_loader.rb +32 -1
  204. data/app/services/hyrax/solr_service.rb +19 -5
  205. data/app/services/hyrax/statistics/collections/over_time.rb +1 -1
  206. data/app/services/hyrax/statistics/query_service.rb +6 -0
  207. data/app/services/hyrax/valkyrie_persist_derivatives.rb +12 -5
  208. data/app/services/hyrax/valkyrie_upload.rb +13 -27
  209. data/app/services/hyrax/versioning_service.rb +29 -15
  210. data/app/services/hyrax/work_uploads_handler.rb +6 -5
  211. data/app/validators/hyrax/collection_membership_validator.rb +1 -1
  212. data/app/views/_user_util_links.html.erb +1 -1
  213. data/app/views/catalog/_search_form.html.erb +1 -1
  214. data/app/views/collections/edit_fields/_based_near.html.erb +11 -7
  215. data/app/views/hyrax/admin/admin_sets/_form_participants.html.erb +67 -67
  216. data/app/views/hyrax/admin/admin_sets/edit.html.erb +1 -1
  217. data/app/views/hyrax/admin/collection_types/_form_participants.html.erb +3 -1
  218. data/app/views/hyrax/admin/collection_types/index.html.erb +1 -1
  219. data/app/views/hyrax/base/_attribute_rows.html.erb +1 -0
  220. data/app/views/hyrax/base/_base_form_files_prepend.html.erb +4 -0
  221. data/app/views/hyrax/base/_file_manager_resource_form.html.erb +1 -1
  222. data/app/views/hyrax/base/_form_files.html.erb +65 -64
  223. data/app/views/hyrax/base/_form_visibility_component.html.erb +4 -4
  224. data/app/views/hyrax/base/_show_actions.html.erb +1 -1
  225. data/app/views/hyrax/base/_workflow_actions.html.erb +25 -23
  226. data/app/views/hyrax/base/show.html.erb +2 -3
  227. data/app/views/hyrax/base/show.json.jbuilder +2 -1
  228. data/app/views/hyrax/collections/_show_document_list_row.html.erb +1 -1
  229. data/app/views/hyrax/collections/show.html.erb +7 -9
  230. data/app/views/hyrax/dashboard/_sidebar.html.erb +4 -3
  231. data/app/views/hyrax/dashboard/collections/_form_share_table.html.erb +2 -2
  232. data/app/views/hyrax/dashboard/collections/_list_collections.html.erb +1 -1
  233. data/app/views/hyrax/dashboard/collections/_show_document_list_row.html.erb +1 -1
  234. data/app/views/hyrax/dashboard/collections/_sort_and_per_page.html.erb +3 -3
  235. data/app/views/hyrax/file_sets/_versioning.html.erb +5 -5
  236. data/app/views/hyrax/file_sets/media_display/_audio.html.erb +5 -5
  237. data/app/views/hyrax/file_sets/media_display/_default.html.erb +1 -1
  238. data/app/views/hyrax/file_sets/media_display/_video.html.erb +3 -3
  239. data/app/views/hyrax/my/_search_form.html.erb +1 -1
  240. data/app/views/hyrax/my/facet.html.erb +1 -1
  241. data/app/views/hyrax/notifications/_notifications.html.erb +1 -1
  242. data/app/views/hyrax/users/_vitals.html.erb +1 -1
  243. data/app/views/layouts/_head_tag_content.html.erb +1 -0
  244. data/app/views/shared/_footer.html.erb +1 -1
  245. data/bin/dev-entrypoint.sh +13 -0
  246. data/chart/hyrax/Chart.yaml +5 -5
  247. data/chart/hyrax/templates/_helpers.tpl +8 -0
  248. data/chart/hyrax/templates/configmap-env.yaml +1 -1
  249. data/chart/hyrax/values.yaml +12 -1
  250. data/config/initializers/file_length_patch.rb +10 -0
  251. data/config/initializers/listeners.rb +1 -1
  252. data/config/locales/hyrax.de.yml +5 -0
  253. data/config/locales/hyrax.en.yml +10 -0
  254. data/config/locales/hyrax.es.yml +5 -0
  255. data/config/locales/hyrax.fr.yml +5 -0
  256. data/config/locales/hyrax.it.yml +5 -0
  257. data/config/locales/hyrax.pt-BR.yml +5 -0
  258. data/config/locales/hyrax.zh.yml +5 -0
  259. data/config/metadata/basic_metadata.yaml +53 -0
  260. data/config/metadata/core_metadata.yaml +6 -0
  261. data/config/metadata/file_set_metadata.yaml +21 -0
  262. data/config/metadata/hyrax_internal_metadata.yaml +57 -0
  263. data/docker-compose-koppie.yml +26 -25
  264. data/docker-compose-sirenia.yml +202 -0
  265. data/docker-compose.yml +27 -24
  266. data/documentation/developing-your-hyrax-based-app.md +77 -60
  267. data/hyrax.gemspec +18 -12
  268. data/karma.conf.js +1 -1
  269. data/lib/generators/hyrax/collection_resource/templates/collection_indexer.rb.erb +1 -1
  270. data/lib/generators/hyrax/collection_resource/templates/collection_metadata.yaml +2 -0
  271. data/lib/generators/hyrax/config_generator.rb +12 -0
  272. data/lib/generators/hyrax/install_generator.rb +37 -7
  273. data/lib/generators/hyrax/listeners_generator.rb +18 -0
  274. data/lib/generators/hyrax/models_generator.rb +1 -10
  275. data/lib/generators/hyrax/riiif_generator.rb +6 -4
  276. data/lib/generators/hyrax/templates/.env +9 -0
  277. data/lib/generators/hyrax/templates/.lando.yml +50 -0
  278. data/lib/generators/hyrax/templates/app/listeners/hyrax_listener.rb +81 -0
  279. data/lib/generators/hyrax/templates/app/models/file_set.rb +1 -2
  280. data/lib/generators/hyrax/templates/config/initializers/1_valkyrie.rb +102 -0
  281. data/lib/generators/hyrax/templates/config/initializers/file_services.rb +6 -0
  282. data/lib/generators/hyrax/templates/config/initializers/hyrax.rb +41 -5
  283. data/lib/generators/hyrax/templates/config/initializers/publisher.rb +3 -0
  284. data/lib/generators/hyrax/templates/config/initializers/riiif.rb +90 -19
  285. data/lib/generators/hyrax/templates/config/locales/hyrax.de.yml +1 -1
  286. data/lib/generators/hyrax/templates/config/locales/hyrax.en.yml +1 -1
  287. data/lib/generators/hyrax/templates/config/locales/hyrax.es.yml +1 -1
  288. data/lib/generators/hyrax/templates/config/locales/hyrax.fr.yml +1 -1
  289. data/lib/generators/hyrax/templates/config/locales/hyrax.it.yml +1 -1
  290. data/lib/generators/hyrax/templates/config/locales/hyrax.pt-BR.yml +1 -1
  291. data/lib/generators/hyrax/templates/config/locales/hyrax.zh.yml +1 -1
  292. data/lib/generators/hyrax/templates/config/redis.yml +3 -6
  293. data/lib/generators/hyrax/templates/config/valkyrie_index.yml +4 -9
  294. data/lib/generators/hyrax/templates/db/migrate/20230725222727_create_hyrax_counter_metrics.rb.erb +14 -0
  295. data/lib/generators/hyrax/templates/db/migrate/20230803165135_change_work_id_to_string.rb.erb +5 -0
  296. data/lib/generators/hyrax/templates/db/migrate/20230808102105_add_indices_to_hyrax_counter_metrics.rb.erb +8 -0
  297. data/lib/generators/hyrax/templates/db/migrate/20230821153635_add_fields_to_counter_metric.rb.erb +8 -0
  298. data/lib/generators/hyrax/templates/db/seeds.rb +1 -1
  299. data/lib/generators/hyrax/work_resource/templates/form.rb.erb +1 -1
  300. data/lib/generators/hyrax/work_resource/templates/indexer.rb.erb +1 -1
  301. data/lib/generators/hyrax/work_resource/templates/metadata.yaml +2 -0
  302. data/lib/hyrax/configuration.rb +241 -55
  303. data/lib/hyrax/controlled_vocabularies/location.rb +7 -1
  304. data/lib/hyrax/engine.rb +0 -1
  305. data/lib/hyrax/form_fields.rb +6 -0
  306. data/lib/hyrax/indexer.rb +1 -1
  307. data/lib/hyrax/publisher.rb +9 -2
  308. data/lib/hyrax/redis_event_store.rb +7 -8
  309. data/lib/hyrax/resource_name.rb +4 -0
  310. data/lib/hyrax/resource_sync/change_list_writer.rb +1 -1
  311. data/lib/hyrax/resource_sync/resource_list_writer.rb +1 -1
  312. data/lib/hyrax/specs/capybara.rb +26 -42
  313. data/lib/hyrax/specs/shared_specs/hydra_works.rb +112 -27
  314. data/lib/hyrax/specs/shared_specs/indexers.rb +25 -7
  315. data/lib/hyrax/transactions/admin_set_destroy.rb +2 -1
  316. data/lib/hyrax/transactions/collection_destroy.rb +3 -2
  317. data/lib/hyrax/transactions/container.rb +47 -0
  318. data/lib/hyrax/transactions/file_metadata_destroy.rb +20 -0
  319. data/lib/hyrax/transactions/file_set_destroy.rb +3 -1
  320. data/lib/hyrax/transactions/file_set_update.rb +21 -0
  321. data/lib/hyrax/transactions/steps/add_to_parent.rb +2 -1
  322. data/lib/hyrax/transactions/steps/check_for_default_admin_set.rb +32 -0
  323. data/lib/hyrax/transactions/steps/check_for_empty_admin_set.rb +1 -1
  324. data/lib/hyrax/transactions/steps/delete_all_file_metadata.rb +46 -0
  325. data/lib/hyrax/transactions/steps/delete_all_file_sets.rb +46 -0
  326. data/lib/hyrax/transactions/steps/file_metadata_delete.rb +40 -0
  327. data/lib/hyrax/transactions/steps/remove_from_membership.rb +45 -0
  328. data/lib/hyrax/transactions/steps/save.rb +2 -1
  329. data/lib/hyrax/transactions/steps/set_user_as_creator.rb +1 -1
  330. data/lib/hyrax/transactions/steps/update_work_members.rb +2 -0
  331. data/lib/hyrax/transactions/work_destroy.rb +3 -2
  332. data/lib/hyrax/version.rb +1 -1
  333. data/lib/hyrax.rb +1 -0
  334. data/lib/tasks/collection_type_global_id.rake +9 -4
  335. data/lib/tasks/embargo_lease.rake +2 -0
  336. data/lib/valkyrie/indexing/solr/indexing_adapter.rb +22 -6
  337. data/lib/wings/active_fedora_converter/default_work.rb +4 -5
  338. data/lib/wings/active_fedora_converter/file_metadata_node.rb +1 -1
  339. data/lib/wings/active_fedora_converter.rb +6 -0
  340. data/lib/wings/attribute_transformer.rb +24 -17
  341. data/lib/wings/model_registry.rb +8 -0
  342. data/lib/wings/model_transformer.rb +19 -10
  343. data/lib/wings/orm_converter.rb +27 -18
  344. data/lib/wings/services/custom_queries/find_ids_by_model.rb +2 -2
  345. data/lib/wings/setup.rb +2 -2
  346. data/lib/wings/valkyrie/query_service.rb +5 -2
  347. data/lib/wings/valkyrie/storage.rb +8 -90
  348. data/lib/wings.rb +8 -0
  349. data/spec/factories/access_control.rb +12 -0
  350. data/spec/factories/admin_sets.rb +32 -0
  351. data/spec/factories/admin_sets_lw.rb +222 -0
  352. data/spec/factories/administrative_sets.rb +79 -0
  353. data/spec/factories/api_items.rb +92 -0
  354. data/spec/factories/collection_branding_infos.rb +12 -0
  355. data/spec/factories/collection_type_participants.rb +9 -0
  356. data/spec/factories/collection_types.rb +139 -0
  357. data/spec/factories/collections.rb +282 -0
  358. data/spec/factories/collections_factory.rb +107 -0
  359. data/spec/factories/content_blocks.rb +5 -0
  360. data/spec/factories/counter_metrics.rb +12 -0
  361. data/spec/factories/featured_works.rb +5 -0
  362. data/spec/factories/file_sets.rb +45 -0
  363. data/spec/factories/generic_works.rb +200 -0
  364. data/spec/factories/hyrax_collection.rb +92 -0
  365. data/spec/factories/hyrax_default_admin_set.rb +7 -0
  366. data/spec/factories/hyrax_embargo.rb +18 -0
  367. data/spec/factories/hyrax_file_metadata.rb +92 -0
  368. data/spec/factories/hyrax_file_set.rb +129 -0
  369. data/spec/factories/hyrax_lease.rb +18 -0
  370. data/spec/factories/hyrax_resource.rb +15 -0
  371. data/spec/factories/hyrax_work.rb +221 -0
  372. data/spec/factories/object_id.rb +7 -0
  373. data/spec/factories/operations.rb +22 -0
  374. data/spec/factories/permission.rb +7 -0
  375. data/spec/factories/permission_template_accesses.rb +17 -0
  376. data/spec/factories/permission_templates.rb +111 -0
  377. data/spec/factories/proxy_deposit_requests.rb +7 -0
  378. data/spec/factories/single_use_links.rb +14 -0
  379. data/spec/factories/sipity_entities.rb +17 -0
  380. data/spec/factories/uploaded_files.rb +11 -0
  381. data/spec/factories/users.rb +52 -0
  382. data/spec/factories/workflow_actions.rb +7 -0
  383. data/spec/factories/workflow_states.rb +7 -0
  384. data/spec/factories/workflows.rb +7 -0
  385. data/spec/support/book_resource.rb +36 -0
  386. data/spec/support/can_can_overrides.rb +43 -0
  387. data/spec/support/clean_solr.rb +7 -0
  388. data/spec/support/controller_level_helpers.rb +27 -0
  389. data/spec/support/factory_helpers.rb +94 -0
  390. data/spec/support/fakes/fake_actor.rb +22 -0
  391. data/spec/support/fakes/fake_authority.rb +14 -0
  392. data/spec/support/fakes/fake_search_builder_scope.rb +44 -0
  393. data/spec/support/fakes/indexing_adapter.rb +17 -0
  394. data/spec/support/fakes/test_hydra_group_service.rb +55 -0
  395. data/spec/support/features/batch_edit_actions.rb +37 -0
  396. data/spec/support/features/session_helpers.rb +15 -0
  397. data/spec/support/features/workflow.rb +10 -0
  398. data/spec/support/features.rb +11 -0
  399. data/spec/support/form_with_validations.rb +15 -0
  400. data/spec/support/input_support.rb +12 -0
  401. data/spec/support/logging_formatter.rb +67 -0
  402. data/spec/support/matchers/api_responses.rb +27 -0
  403. data/spec/support/matchers/collection_type_property_matchers.rb +30 -0
  404. data/spec/support/matchers/embargo.rb +9 -0
  405. data/spec/support/matchers/lease.rb +9 -0
  406. data/spec/support/matchers/match_valkyrie_ids_with_af_ids.rb +12 -0
  407. data/spec/support/matchers/pcdm_matchers.rb +34 -0
  408. data/spec/support/matchers/permission.rb +31 -0
  409. data/spec/support/matchers/response_matchers.rb +8 -0
  410. data/spec/support/optional_example.rb +17 -0
  411. data/spec/support/rake.rb +42 -0
  412. data/spec/support/selectors.rb +112 -0
  413. data/spec/support/shared_examples_for_collection_presenter.rb +44 -0
  414. data/spec/support/simple_work.rb +28 -0
  415. data/spec/support/spec_statistic.rb +24 -0
  416. data/spec/support/speedup.rb +7 -0
  417. data/spec/support/statistic_helper.rb +10 -0
  418. data/spec/support/valkyrie_indexing.rb +2 -0
  419. data/spec/support/wings_models.rb +9 -0
  420. data/tasks/hyrax_dev.rake +2 -33
  421. data/template.rb +1 -3
  422. metadata +184 -84
  423. data/.engine_cart.yml +0 -3
  424. data/app/indexers/hyrax/resource_indexer.rb +0 -15
  425. data/app/services/hyrax/characterization/model_wrapper.rb +0 -0
  426. data/app/services/hyrax/custom_queries/find_by_collection_type.rb +0 -0
  427. data/app/services/hyrax/query_service.rb +0 -0
  428. data/app/views/hyrax/users/_user_util_links_extra.html.erb +0 -0
  429. data/lib/hyrax/specs/disable_animations_in_test_environment.rb +0 -53
  430. data/lib/hyrax/specs/shared_specs/valkyrie_storage_versions.rb +0 -9
  431. /data/app/indexers/{hyrax → concerns/hyrax}/thumbnail_indexer.rb +0 -0
@@ -19,14 +19,9 @@ module Wings
19
19
  # For use with Hyrax, this adapter defaults to Fedora 4.
20
20
  class Storage < ::Valkyrie::Storage::Fedora
21
21
  DEFAULT_CTYPE = 'application/octet-stream'
22
- LINK_HEADER = "<http://www.w3.org/ns/ldp#NonRDFSource>; rel=\"type\""
23
22
  FILES_PATH = 'files'
24
- VERSIONS_SLUG = '/fcr:versions'
25
-
26
- attr_reader :sha1
27
23
 
28
24
  def initialize(connection: Ldp::Client.new(ActiveFedora.fedora.host), base_path: ActiveFedora.fedora.base_path, fedora_version: 4)
29
- @sha1 = fedora_version == 5 ? "sha" : "sha1"
30
25
  super
31
26
  end
32
27
 
@@ -36,84 +31,19 @@ module Wings
36
31
  ::Valkyrie::ID.new(id.to_s.sub(/^.+\/\//, PROTOCOL))
37
32
  end
38
33
 
39
- ##
40
- # @param key [Symbol] the key for plugin behavior to check support for
41
- #
42
- # @return [Boolean] whether
43
- def supports?(key)
44
- key == :versions
45
- end
46
-
47
34
  def upload(file:, original_filename:, resource:, content_type: DEFAULT_CTYPE, # rubocop:disable Metrics/ParameterLists
48
- resource_uri_transformer: default_resource_uri_transformer, use: Hydra::PCDM::Vocab::PCDMTerms.File,
49
- id_hint: 'original', **extra_arguments)
35
+ resource_uri_transformer: default_resource_uri_transformer, use: Hydra::PCDM::Vocab::PCDMTerms.File, # rubocop:disable Lint/UnusedMethodArgument
36
+ id_hint: 'original', **_extra_arguments)
50
37
  id = if resource.try(:file_set?)
51
38
  upload_with_works(resource: resource, file: file, use: use)
52
39
  else
53
- put_file(file: file,
54
- original_filename: original_filename,
55
- resource: resource,
56
- content_type: content_type,
57
- resource_uri_transformer: resource_uri_transformer,
58
- id_hint: id_hint, **extra_arguments)
40
+ return super(file: file, original_filename: original_filename, resource: resource, content_type: content_type, resource_uri_transformer: resource_uri_transformer_factory(id_hint))
59
41
  end
60
-
61
42
  find_by(id: cast_to_valkyrie_id(id))
62
43
  end
63
44
 
64
- ##
65
- # @return [Enumerable<Version> ordered list of versions
66
- def find_versions(id:)
67
- response = connection.http.get(fedora_identifier(id: id) + VERSIONS_SLUG)
68
- return [] if response.status == 404
69
-
70
- reader = RDF::Reader.for(content_type: response.headers['content-type'])
71
- version_graph = RDF::Graph.new << reader.new(response.body)
72
- query = { predicate: RDF::Vocab::Fcrepo4.hasVersion }
73
-
74
- version_graph.query(query).objects.map do |uri|
75
- timestamp =
76
- version_graph.query([uri, RDF::Vocab::Fcrepo4.created, :created])
77
- .first_object
78
- .object
79
- Version.new(id: cast_to_valkyrie_id(uri.to_s), created: timestamp, adapter: self)
80
- end.sort
81
- end
82
-
83
- ##
84
- # abstractly, {Version} objects should have an {#id} and be orderable
85
- # over {#<=>} (allowing e.g. `#sort` to define a consistent order---
86
- # oldest to newest---for a collection of versions). the {#id} should be a
87
- # globally unique identifier for the version.
88
- #
89
- # this implementation uses an orderable {#version_token}. in practice
90
- # the token is the fcrepo created date for the version, as extracted from
91
- # the versions graph.
92
- Version = Struct.new("Version", :id, :created, :adapter, keyword_init: true) do
93
- include Comparable
94
-
95
- ##
96
- # @return [#read]
97
- def io
98
- adapter.find_by(id: id)
99
- end
100
-
101
- def version_token
102
- created
103
- end
104
-
105
- def <=>(other)
106
- raise ArgumentError unless other.respond_to?(:version_token)
107
- version_token <=> other.version_token
108
- end
109
- end
110
-
111
45
  private
112
46
 
113
- def digest_for(file)
114
- "#{sha1}=#{Digest::SHA1.file(file)}"
115
- end
116
-
117
47
  def default_resource_uri_transformer
118
48
  lambda do |resource, hint|
119
49
  id = [CGI.escape(resource.id), FILES_PATH, hint].join('/')
@@ -121,24 +51,12 @@ module Wings
121
51
  end
122
52
  end
123
53
 
124
- ##
125
- # Create a file with HTTP put; no containers here.
126
- # @return [String] the identifier of the created file
127
- def put_file(file:, original_filename:, resource:, content_type:, # rubocop:disable Metrics/ParameterLists
128
- resource_uri_transformer:, id_hint:, **_extra_arguments)
129
- identifier = resource_uri_transformer.call(resource, id_hint)
130
-
131
- connection.http.put do |request|
132
- request.url identifier
133
- request.headers['Content-Type'] = content_type
134
- request.headers['Content-Length'] = (file.try(:size) || file.try(:length)).to_s
135
- request.headers['Content-Disposition'] = "attachment; filename=\"#{original_filename}\""
136
- request.headers['digest'] = digest_for(file)
137
- request.headers['link'] = LINK_HEADER
138
- request.body = Faraday::UploadIO.new(file, content_type, original_filename)
54
+ # Transforms default_resource_uri_transformer to conform to Valkyrie's
55
+ # expected interface of passing a resource and base url.
56
+ def resource_uri_transformer_factory(hint)
57
+ lambda do |resource, _base_url|
58
+ default_resource_uri_transformer.call(resource, hint)
139
59
  end
140
-
141
- identifier
142
60
  end
143
61
 
144
62
  def upload_with_works(resource:, file:, use:)
data/lib/wings.rb CHANGED
@@ -1,5 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ # Short circuit loading if Wings is disabled
4
+ return if Hyrax.config.disable_wings
5
+
3
6
  ##
4
7
  # Wings is a toolkit integrating Valkyrie into Hyrax as a bridge away from the
5
8
  # hard dependency on ActiveFedora.
@@ -15,6 +18,8 @@
15
18
  # However, these dependencies should be considered temprorary: this code will
16
19
  # be deprecated for removal in a future release.
17
20
  #
21
+ # @deprecated Wings will be removed when ActiveFedora is no longer supported by Hyrax.
22
+ #
18
23
  # @example casting an ActiveFedora model to Valkyrie
19
24
  # work = GenericWork.create(title: ['Comet in Moominland'])
20
25
  # resource = work.valkyrie_resource
@@ -56,6 +61,9 @@
56
61
  # @see https://wiki.duraspace.org/display/samvera/Hyrax-Valkyrie+Development+Working+Group
57
62
  # for further context regarding the approach
58
63
  module Wings
64
+ Deprecation.warn(self, "ActiveFedora and Wings will be removed from a future major release of Hyrax in favor " \
65
+ "of Valkyrie resource models. Please migrate your models from ActiveFedora::Base to Hyrax::Resource.")
66
+
59
67
  ##
60
68
  # @api public
61
69
  #
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+ FactoryBot.define do
3
+ factory :access_control, class: Hyrax::AccessControl do
4
+ permissions { build(:permission) }
5
+
6
+ trait :with_target do
7
+ access_to { valkyrie_create(:hyrax_resource).id }
8
+
9
+ permissions { build(:permission, access_to: access_to) }
10
+ end
11
+ end
12
+ end
@@ -0,0 +1,32 @@
1
+ # frozen_string_literal: true
2
+ FactoryBot.define do
3
+ factory :admin_set do
4
+ sequence(:title) { |n| ["Title #{n}"] }
5
+
6
+ # Given the relationship between permission template and admin set, when
7
+ # an admin set is created via a factory, I believe it is appropriate to go ahead and
8
+ # create the corresponding permission template
9
+ #
10
+ # This way, we can go ahead
11
+ after(:create) do |admin_set, evaluator|
12
+ if evaluator.with_permission_template
13
+ attributes = { source_id: admin_set.id }
14
+ attributes = evaluator.with_permission_template.merge(attributes) if evaluator.with_permission_template.respond_to?(:merge)
15
+ # There is a unique constraint on permission_templates.source_id; I don't want to
16
+ # create a permission template if one already exists for this admin_set
17
+ create(:permission_template, attributes) unless Hyrax::PermissionTemplate.find_by(source_id: admin_set.id)
18
+ end
19
+ end
20
+
21
+ transient do
22
+ # false, true, or Hash with keys for permission_template
23
+ with_permission_template { false }
24
+ end
25
+
26
+ factory :complete_admin_set do
27
+ alternative_title { ['alternative admin set title'] }
28
+ creator { ['moomin', 'snufkin'] }
29
+ description { ['Before a revolution happens', 'it is perceived as impossible'] }
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,222 @@
1
+ # frozen_string_literal: true
2
+ FactoryBot.define do
3
+ # Tests that create a Fedora Object are very slow. This factory lets you control which parts of the object ecosystem
4
+ # get built.
5
+ #
6
+ # PREFERRED: Use build whenever possible. You can control the creation of the permission template and solr document
7
+ # by passing parameters to the build(:admin_set_lw) method. That way you can build only the parts needed
8
+ # for a specific test.
9
+ #
10
+ # AVOID: Do not use create unless absolutely necessary. It will create everything including the Fedora object.
11
+ #
12
+ # @example Simple build of an admin set with no additional parts created. Lightest weight.
13
+ # NOTE: A user is automatically created as the owner of the admin set.
14
+ # let(:adminset) { build(:adminset_lw) }
15
+ #
16
+ # @example Simple build of an admin set with no additional parts created. User is the owner of the admin set. Lightest weight.
17
+ # let(:adminset) { build(:adminset_lw, user:) }
18
+ #
19
+ # @example Simple build of an admin set with only solr-document. Owner is given edit-access in solr-document. Light weight.
20
+ # let(:adminset) { build(:adminset_lw, with_solr_document: true) }
21
+ #
22
+ # @example Simple build of an admin set with only a permission template created. Owner is set as a manager. Light weight.
23
+ # let(:adminset) { build(:adminset_lw, with_permission_template: true) }
24
+ #
25
+ # @example Build an admin set with only a permission template created. Permissions are set based on
26
+ # attributes set for `with_permission_template`. Middle weight.
27
+ # # permissions passed thru `with_permission_template` can be any of the following in any combination
28
+ # let(:permissions) { { manage_users: [user.user_key], # multiple users can be listed
29
+ # deposit_users: [user.user_key],
30
+ # view_users: [user.user_key],
31
+ # manage_groups: [group_name], # multiple groups can be listed
32
+ # deposit_groups: [group_name],
33
+ # view_groups: [group_name], } }
34
+ # let(:adminset) { build(:adminset_lw, user: , with_permission_template: permissions) }
35
+ #
36
+ # @example Build an admin set with permission template and solr-document created. Permissions are set based on
37
+ # attributes set for `with_permission_template`. Solr-document includes read/edit access defined based
38
+ # on attributes passed thru `with_permission_template`. Middle weight.
39
+ # # permissions passed thru `with_permission_template` can be any of the following in any combination
40
+ # let(:permissions) { { manage_users: [user.user_key], # multiple users can be listed
41
+ # deposit_users: [user.user_key],
42
+ # view_users: [user.user_key],
43
+ # manage_groups: [group_name], # multiple groups can be listed
44
+ # deposit_groups: [group_name],
45
+ # view_groups: [group_name], } }
46
+ # let(:adminset) { build(:adminset_lw, user: , with_permission_template: permissions, with_solr_document: true) }
47
+ #
48
+ # @example Create an admin set with everything. Extreme heavy weight. This is very slow and should be avoided.
49
+ # NOTE: Everything gets created.
50
+ # NOTE: Build options effect created admin sets as follows...
51
+ # * `with_permission_template` can specify user/group permissions. A permission template is always created.
52
+ # * `with_solr_document` is ignored. A solr document is always created.
53
+ # let(:adminset) { create(:adminset_lw) }
54
+ #
55
+ # @example Build the default admin set with permission template, solr doc, and default adminset's metadata.
56
+ # let(:default_adminset) { build(:default_adminset) }
57
+
58
+ factory :adminset_lw, class: AdminSet do
59
+ transient do
60
+ user { FactoryBot.create(:user) }
61
+
62
+ with_permission_template { false }
63
+ with_solr_document { false }
64
+ end
65
+ sequence(:title) { |n| ["Collection Title #{n}"] }
66
+
67
+ after(:build) do |adminset, evaluator|
68
+ adminset.creator = [evaluator.user.user_key]
69
+
70
+ AdminSetFactoryHelper.process_with_permission_template(adminset, evaluator)
71
+ AdminSetFactoryHelper.process_with_solr_document(adminset, evaluator)
72
+ end
73
+
74
+ before(:create) do |adminset, evaluator|
75
+ # force create a permission template if it doesn't exist for the newly created admin set
76
+ AdminSetFactoryHelper.process_with_permission_template(adminset, evaluator, true) unless evaluator.with_permission_template
77
+ end
78
+
79
+ after(:create) do |adminset, _evaluator|
80
+ adminset.permission_template.reset_access_controls_for(collection: adminset)
81
+ end
82
+
83
+ factory :default_adminset, class: AdminSet do
84
+ transient do
85
+ with_permission_template do
86
+ {
87
+ deposit_groups: [::Ability.registered_group_name],
88
+ manage_groups: [::Ability.admin_group_name]
89
+ }
90
+ end
91
+ with_solr_document { true }
92
+ with_persisted_default_id { true }
93
+ end
94
+ id { AdminSet::DEFAULT_ID }
95
+ title { AdminSet::DEFAULT_TITLE }
96
+
97
+ after(:create) do |admin_set, evaluator|
98
+ Hyrax::DefaultAdministrativeSet.update(default_admin_set_id: admin_set.id) if
99
+ evaluator.with_persisted_default_id
100
+ end
101
+ end
102
+ end
103
+
104
+ factory :no_solr_grants_adminset, class: AdminSet do
105
+ # Builds a pre-Hyrax 2.1.0 adminset without edit/view grants on the admin set.
106
+ # Do not use with create because the save will cause the solr grants to be created.
107
+ transient do
108
+ user { FactoryBot.create(:user) }
109
+ with_permission_template { true }
110
+ with_solr_document { true }
111
+ end
112
+
113
+ sequence(:title) { |n| ["No Solr Grant Admin Set Title #{n}"] }
114
+
115
+ after(:build) do |adminset, evaluator|
116
+ adminset.creator = [evaluator.user.user_key]
117
+ AdminSetFactoryHelper.process_with_permission_template(adminset, evaluator, true)
118
+ AdminSetFactoryHelper.process_with_solr_document(adminset, evaluator, true)
119
+ end
120
+ end
121
+
122
+ class AdminSetFactoryHelper
123
+ # @returns array of user keys
124
+ def self.permission_from_template(permission_template_attributes, permission_key)
125
+ permissions = []
126
+ return permissions if permission_template_attributes.blank?
127
+ return permissions unless permission_template_attributes.is_a? Hash
128
+ return permissions unless permission_template_attributes.key?(permission_key)
129
+ permission_template_attributes[permission_key]
130
+ end
131
+ private_class_method :permission_from_template
132
+
133
+ # @param [Hash] permission_template_attributes where names identify the role and value are the user keys for that role
134
+ # @parem [String] creator_user is the user who created the new admin set
135
+ # @param [Boolean] include_creator, when true, adds the creator_user as a manager
136
+ # @returns array of user keys
137
+ def self.user_managers(permission_template_attributes, creator_user)
138
+ managers = permission_from_template(permission_template_attributes, :manage_users)
139
+ managers << creator_user
140
+ managers.uniq
141
+ end
142
+
143
+ # @param [Hash] permission_template_attributes where names identify the role and value are the user keys for that role
144
+ # @returns array of user keys
145
+ def self.group_managers(permission_template_attributes)
146
+ permission_from_template(permission_template_attributes, :manage_groups).uniq
147
+ end
148
+
149
+ # @param [Hash] permission_template_attributes where names identify the role and value are the user keys for that role
150
+ # @returns array of user keys
151
+ def self.user_depositors(permission_template_attributes)
152
+ permission_from_template(permission_template_attributes, :deposit_users).uniq
153
+ end
154
+
155
+ # @param [Hash] permission_template_attributes where names identify the role and value are the user keys for that role
156
+ # @returns array of user keys
157
+ def self.group_depositors(permission_template_attributes)
158
+ permission_from_template(permission_template_attributes, :deposit_groups).uniq
159
+ end
160
+
161
+ # @param [Hash] permission_template_attributes where names identify the role and value are the user keys for that role
162
+ # @returns array of user keys
163
+ def self.user_viewers(permission_template_attributes)
164
+ permission_from_template(permission_template_attributes, :view_users).uniq
165
+ end
166
+
167
+ # @param [Hash] permission_template_attributes where names identify the role and value are the user keys for that role
168
+ # @returns array of user keys
169
+ def self.group_viewers(permission_template_attributes)
170
+ permission_from_template(permission_template_attributes, :view_groups).uniq
171
+ end
172
+
173
+ # Process the with_permission_template transient property such that...
174
+ # * a permission template is created for the admin set
175
+ # * a permission template access is created for the admin set creator
176
+ # * additional permission template accesses are created for each user/group identified in the attributes
177
+ # of with_permission_template (created by the permission_template factory)
178
+ # @param [AdminSet] admin set object being built/created by the factory
179
+ # @param [Class] evaluator holding the transient properties for the current build/creation process
180
+ # @param [Boolean] if true, force the permission template to be created
181
+ def self.process_with_permission_template(adminset, evaluator, force = false)
182
+ return unless force || evaluator.with_permission_template
183
+ adminset.id ||= FactoryBot.generate(:object_id)
184
+ attributes = { source_id: adminset.id }
185
+ attributes[:manage_users] = user_managers(evaluator.with_permission_template, evaluator.user)
186
+ attributes = evaluator.with_permission_template.merge(attributes) if evaluator.with_permission_template.respond_to?(:merge)
187
+ FactoryBot.create(:permission_template, attributes) unless Hyrax::PermissionTemplate.find_by(source_id: adminset.id)
188
+ end
189
+
190
+ # Process the with_solr_document transient property such that...
191
+ # * a solr document is created for the admin set
192
+ # * permissions identified by with_permission_template, if any, are added to the solr fields
193
+ # @param [AdminSet] adminset object being built/created by the factory
194
+ # @param [Class] evaluator holding the transient properties for the current build/creation process
195
+ def self.process_with_solr_document(adminset, evaluator, creator_only = false)
196
+ return unless creator_only || evaluator.with_solr_document
197
+ Hyrax::SolrService.add(solr_document_with_permissions(adminset, evaluator, creator_only), commit: true)
198
+ end
199
+
200
+ # Return the admin set's solr document with permissions added, such that...
201
+ # * permissions identified by with_permission_template, if any, are added to the solr fields
202
+ # @param [AdminSet] adminset object being built/created by the factory
203
+ # @param [Class] evaluator holding the transient properties for the current build/creation process
204
+ # @returns the admin set's solr document with permissions added
205
+ def self.solr_document_with_permissions(adminset, evaluator, creator_only)
206
+ adminset.id ||= FactoryBot.generate(:object_id)
207
+ if creator_only
208
+ adminset.edit_users = [evaluator.user]
209
+ else
210
+ adminset.edit_users = user_managers(evaluator.with_permission_template, evaluator.user)
211
+ adminset.edit_groups = group_managers(evaluator.with_permission_template)
212
+ adminset.read_users = user_viewers(evaluator.with_permission_template) +
213
+ user_depositors(evaluator.with_permission_template)
214
+ adminset.read_groups = group_viewers(evaluator.with_permission_template) +
215
+ group_depositors(evaluator.with_permission_template) -
216
+ [::Ability.registered_group_name, ::Ability.public_group_name]
217
+ end
218
+ adminset.to_solr
219
+ end
220
+ private_class_method :solr_document_with_permissions
221
+ end
222
+ end
@@ -0,0 +1,79 @@
1
+ # frozen_string_literal: true
2
+
3
+ FactoryBot.define do
4
+ ##
5
+ # This factory creates a Valkyrized adminstrative set; by default a Hyrax::AdministrativeSet
6
+ #
7
+ # Why the antics around the class? Because of the Hyrax needs and potential downstream
8
+ # applciation needs.
9
+ #
10
+ # Downstream applications might implement a different # administrative set and the downstream
11
+ # application might leverage other Hyrax factories that create a `:hyrax_admin_set`
12
+ # (e.g. `:permission_template`)
13
+ factory :hyrax_admin_set, class: (Hyrax.config.admin_set_class < Valkyrie::Resource ? Hyrax.config.admin_set_class : Hyrax::AdministrativeSet) do
14
+ title { ['My Admin Set'] }
15
+
16
+ transient do
17
+ with_permission_template { false }
18
+ user { FactoryBot.create(:user) }
19
+ access_grants { [] }
20
+ with_index { true }
21
+ end
22
+
23
+ after(:build) do |adminset, evaluator|
24
+ adminset.creator = [evaluator.user.user_key]
25
+ end
26
+
27
+ after(:create) do |admin_set, evaluator|
28
+ admin_set.permission_manager.edit_groups = evaluator.edit_groups
29
+ admin_set.permission_manager.edit_users = evaluator.edit_users
30
+ admin_set.permission_manager.read_users = evaluator.read_users
31
+ admin_set.permission_manager.read_groups = evaluator.read_groups
32
+
33
+ admin_set.permission_manager.acl.save
34
+
35
+ if evaluator.with_permission_template
36
+ template = Hyrax::PermissionTemplate.find_or_create_by(source_id: admin_set.id.to_s)
37
+ evaluator.access_grants.each do |grant|
38
+ Hyrax::PermissionTemplateAccess.find_or_create_by(permission_template_id: template.id,
39
+ agent_type: grant[:agent_type],
40
+ agent_id: grant[:agent_id],
41
+ access: grant[:access])
42
+ end
43
+ Hyrax::PermissionTemplateAccess.find_or_create_by(permission_template_id: template.id,
44
+ agent_type: Hyrax::PermissionTemplateAccess::USER,
45
+ agent_id: evaluator.user.user_key,
46
+ access: Hyrax::PermissionTemplateAccess::MANAGE)
47
+ template.reset_access_controls_for(collection: admin_set)
48
+ end
49
+ Hyrax.index_adapter.save(resource: admin_set) if evaluator.with_index
50
+ end
51
+ end
52
+
53
+ trait :with_permission_template do
54
+ with_permission_template { true }
55
+ access_grants do
56
+ [{ agent_type: Hyrax::PermissionTemplateAccess::USER,
57
+ agent_id: user.user_key,
58
+ access: Hyrax::PermissionTemplateAccess::MANAGE }]
59
+ end
60
+ end
61
+
62
+ factory :invalid_hyrax_admin_set, class: 'Hyrax::AdministrativeSet' do
63
+ # Title is required. Without title, the admin set is invalid.
64
+ end
65
+
66
+ factory :default_hyrax_admin_set, class: 'Hyrax::AdministrativeSet' do
67
+ id { Hyrax::AdminSetCreateService::DEFAULT_ID }
68
+ title { Hyrax::AdminSetCreateService::DEFAULT_TITLE }
69
+
70
+ transient do
71
+ with_persisted_default_id { true }
72
+ end
73
+
74
+ after(:create) do |admin_set, evaluator|
75
+ Hyrax::DefaultAdministrativeSet.update(default_admin_set_id: admin_set.id) if
76
+ evaluator.with_persisted_default_id
77
+ end
78
+ end
79
+ end
@@ -0,0 +1,92 @@
1
+ # frozen_string_literal: true
2
+ FactoryBot.define do
3
+ factory :post_item, class: Hash do
4
+ skip_create
5
+
6
+ token { 'mock_token' }
7
+
8
+ metadata do
9
+ {
10
+ resourceType: 'Dataset',
11
+ title: 'Findings from NSF Study',
12
+ creators: [
13
+ {
14
+ creatorType: 'author',
15
+ firstName: 'John',
16
+ lastName: 'Doe'
17
+ },
18
+ {
19
+ creatorType: 'seriesEditor',
20
+ firstName: 'Rafael',
21
+ lastName: 'Nadal'
22
+ },
23
+ {
24
+ creatorType: 'inventor',
25
+ name: 'Babs McGee'
26
+ },
27
+ {
28
+ creatorType: 'contributor',
29
+ name: 'Jane Doeski'
30
+ }
31
+ ],
32
+ description: 'This was funded by the NSF in 2013',
33
+ publisher: 'National Science Foundation',
34
+ dateCreated: '2014-11-02T14:24:64Z',
35
+ basedNear: 'Paris, France',
36
+ identifier: 'isbn:1234567890',
37
+ url: 'http://example.org/nsf/2013/datasets/',
38
+ language: 'English--New Jerseyan',
39
+ license: 'http://creativecommons.org/licenses/by-sa/3.0/us/',
40
+ tags: [
41
+ 'datasets',
42
+ 'nsf',
43
+ 'stuff'
44
+ ]
45
+ }
46
+ end
47
+
48
+ file do
49
+ {
50
+ base64: 'YXJraXZvCg==',
51
+ md5: 'f03313ded2feb96f0a641b8eb098aae0',
52
+ filename: 'file.txt',
53
+ contentType: 'text/plain'
54
+ }
55
+ end
56
+
57
+ initialize_with { attributes }
58
+ end
59
+
60
+ factory :put_item, class: Hash, parent: :post_item do
61
+ metadata do
62
+ {
63
+ resourceType: 'Article',
64
+ title: 'THE REAL FINDINGS',
65
+ creators: [
66
+ {
67
+ creatorType: 'author',
68
+ firstName: 'John',
69
+ lastName: 'Doe'
70
+ },
71
+ {
72
+ creatorType: 'inventor',
73
+ name: 'Babs McGee'
74
+ }
75
+ ],
76
+ license: 'http://creativecommons.org/licenses/by-sa/3.0/us/',
77
+ tags: [
78
+ 'datasets'
79
+ ]
80
+ }
81
+ end
82
+
83
+ file do
84
+ {
85
+ base64: 'IyBIRUFERVIKClRoaXMgaXMgYSBwYXJhZ3JhcGghCg==',
86
+ md5: '3923077bb477097b8496dbcff5fa44b3',
87
+ filename: 'replaced.md',
88
+ contentType: 'text/x-markdown'
89
+ }
90
+ end
91
+ end
92
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+ FactoryBot.define do
3
+ factory :collection_branding_info do
4
+ collection_id { "1" }
5
+ role { "banner" }
6
+ local_path { "/fake/path/to/banner.png" }
7
+ alt_text { "This is the banner" }
8
+ target_url { "http://example.com/" }
9
+ height { "" }
10
+ width { "" }
11
+ end
12
+ end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+ FactoryBot.define do
3
+ factory :collection_type_participant, class: Hyrax::CollectionTypeParticipant do
4
+ association :hyrax_collection_type, factory: :collection_type
5
+ sequence(:agent_id) { |n| "user#{n}@example.com" }
6
+ agent_type { 'user' }
7
+ access { Hyrax::CollectionTypeParticipant::MANAGE_ACCESS }
8
+ end
9
+ end