Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Valkyrize Knapsack + Review knapsacking effort #13

Merged
merged 31 commits into from
May 21, 2024

Conversation

jeremyf
Copy link
Contributor

@jeremyf jeremyf commented Apr 16, 2024

This is the original branch for our Knapsacking effort.
After getting a bit unruly, we separated and merged all the bits before we started valkyrizing.
This PR should contain knapsacking + valkyrizing efforts only

ref:

Issues:

TODO:

  • Actors
    • OerActor -> Transaction [ create as a separate ticket]
  • Controller
  • Factories
  • Forms (most of this should be handled by the yaml) [Kirk]
    • EtdForm
    • CdlForm
    • OerForm
    • GenericWorkFormDecorator
    • ImageDecorator
    • FileSet
  • Helpers
    • Hyrax::OverrideHelperBehavior [SHANA]
  • Indexers (most of this should be handled by the yaml) [Shana/Kirk]
    • EtdResourceIndexer
    • CdlResourceIndexer
    • OerResourceIndexer
    • ImageResourceIndexer
    • GenericResourceIndexer
    • FileSet
  • Jobs [Kirk]
    • app/jobs/iiif_print/create_relationships_job_decorator.rb
    • app/jobs/attach_files_to_work_job_decorator.rb
      • This seems to be the old implementation to allow pdfs to be displayed in the viewer by converting them to jpgs.
    • app/jobs/create_group_and_add_members_job.rb
    • app/jobs/bulkrax/related_memberships_job.rb
  • Models [Kirk]
    • EtdResource
    • CdlResource
    • OerResource
    • GenericWorkDecorator
    • ImageDecorator
    • GenericWorkResourceDecorator (probably just need to alter the yaml)
    • ImageResourceDecorator (probably just need to alter the yaml)
    • FileSet
  • Parsers
    • app/parsers/bulkrax/csv_parser_decorator.rb
    • app/parsers/bulkrax/oer_csv_parser.rb
  • Presenters (do we need presenters or do we need to handle it a separate way?) => I think we can use the pre-existing presenters (SHANA)
    • CdlResourcePresenter
    • EtdResourcePresenter
    • OerResourcePresenter
  • Video Embed form field
  • Convert model/controller/etc callbacks to listeners
    • CDL
      • before_destroy :destroy_split_pages (should be handled by IIIF Print)
      • after_destroy :destroy_cdl_group
    • COLLECTION
      • :remote_featured
  • SPECS (handle in another ticket)
  • LINT (handle in another ticket)

---

🚧 Add files from PALs Hyku not in other repos

3595d6f

This is a first pass of the PALs work. There was a lot of head
scratching and copying things into Hyku Prime. Together this is a
rough process.

🚧 Partial port of PALs Hyku entries

fac9882

Move functionality to Hyku prime

c0a37d5

Review and override file_set_helper.rb

a274a65

Favor pushing views down into Hyku Prime

0a34b07

Ongoing review of files that were different in 3 or more repositories

1357812

Blank out rendering of Generic Work title

63b6b6b

Adding collections/show as this is unique to PALs

183fdd7

Add custom catalog controller for PALs

de326b4

🎁 Decorate ApplicationController based on PALs criteria

b3e8bda

@@ -0,0 +1,10 @@
# frozen_string_literal: true
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this go back to Hyku? It's unclear.

@@ -0,0 +1,50 @@
# frozen_string_literal: true

module Blacklight
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should these go back to Hyku?

@@ -0,0 +1,12 @@
# frozen_string_literal: true

# OVERRIDE Blacklight 6.7.0 to enable markdown in the facets
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this go back to Hyku?


# OVERRIDE blacklight 6 to allow full url for show links for shared search thumbnail
module Blacklight
module CatalogHelperBehaviorDecorator
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this go back to Hyku? I believe so given that it has generic_work_url

@@ -0,0 +1,12 @@
# frozen_string_literal: true
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This goes back to Hyku

@@ -0,0 +1,14 @@
# frozen_string_literal: true

module Hyrax
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The citation formatters might go back to Hyku

@@ -0,0 +1,30 @@
# Hyrax Override: Improve Citations Format
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The citation formatters might go back to Hyku

@@ -0,0 +1,94 @@
# Hyrax Override: Improve Format of Citations
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The citation formatters might go back to Hyku

@@ -2,5 +2,20 @@

module HykuKnapsack
module ApplicationHelper
# OVERRIDE Hyrax::FileSetHelper#media_display_partial
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this go back to Hyku?

@@ -0,0 +1,64 @@
# Hyrax Override: Improve Citations Format
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The citation formatters might go back to Hyku

@@ -0,0 +1,75 @@
# Hyrax Override: Improve Citations Format
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The citation formatters might go back to Hyku

@@ -0,0 +1,48 @@
# Hyrax Override: Improve Citations Format
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The citation formatters might go back to Hyku

@@ -0,0 +1,58 @@
# frozen_string_literal: true
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Back to Hyku?

@@ -0,0 +1,11 @@
# frozen_string_literal: true

module AppIndexerDecorator
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Back to Hyku?

# frozen_string_literal: true

# OVERRIDE BULKRAX 8.0.0
module Bulkrax
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this go back to Hyku?


# OVERRIDE: Hyrax 5.0.1 to handed is_derived
class AttachFilesToWorkJobDecorator
def attach_work(user, work, work_attributes, work_permissions, uploaded_file)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this go back to Hyku?

@@ -0,0 +1,79 @@
# frozen_string_literal: true
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this go back to Hyku?

@@ -0,0 +1,13 @@
# frozen_string_literal: true
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Back to Hyku?

@@ -0,0 +1,32 @@
# frozen_string_literal: true

module GenericWorkDecorator
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Back to Hyku?

@@ -0,0 +1,18 @@
# frozen_string_literal: true
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Back to Hyku?

@@ -0,0 +1,67 @@
# frozen_string_literal: true
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Likely something that should go back to Bulkrax

@@ -0,0 +1,25 @@
module Hyrax
module AccessibilityFeaturesService
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these something to go back to Hyku?

@@ -0,0 +1,25 @@
module Hyrax
module AccessibilityHazardsService
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these something that goes back to Hyku?

@@ -0,0 +1,25 @@
module Hyrax
module AudienceService
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these something to send back to Hyku?

@@ -0,0 +1,20 @@
module Hyrax
# Provide select options for the types field
class ContributingLibraryService < QaSelectService
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this something to send back to Hyku?

@@ -0,0 +1,25 @@
module Hyrax
module DisciplineService
mattr_accessor :authority
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this something that belongs in Hyku?

@@ -0,0 +1,25 @@
module Hyrax
module EducationLevelsService
mattr_accessor :authority
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something that belongs in Hyku?

@@ -0,0 +1,25 @@
module Hyrax
module LearningResourceTypesService
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something that belongs in Hyku?

@@ -0,0 +1,25 @@
module Hyrax
module OerTypesService
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something that belongs in Hyku?

@@ -0,0 +1,73 @@
<%# OVERRIDE: Hyrax v5.0.1 to show the user/depositor's display_name if available %>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps something for Hyku?

@ShanaLMoore ShanaLMoore mentioned this pull request May 17, 2024
@ShanaLMoore ShanaLMoore changed the title Review knapsacking effort Valkyrize Knapsack + Review knapsacking effort May 17, 2024
ShanaLMoore and others added 4 commits May 17, 2024 08:54
This commit will load the decorators earlier in the initialization.
In this commit I've added custom index terms to each resource indexer.
We remove the controllers because they are no longer needed and use the
AF models' controllers instead.
ShanaLMoore and others added 14 commits May 17, 2024 14:58
TODO: add Image and generic work properties to the decorator yaml files
These two jobs were adjusted to the Valkyrie paradigm.  The
AttachFilesToWorkJobDecorator needs more context before I can change it
and the Bulkrax::RelatedMembershipsJob seems like it should work, but
we'll see with testing.  The spec for CreateGroupAndAddMembersJob will
be addressed later.
This commit will also add the same condition pattern we used in the
model and update the yaml to mirror the old fields.
This commit reworks the prior ones, to allow us to override metadata defined in Hyku.
This commit will fix the Oer edit page because it was not loading
correctly and also the required badge in the forms.
This commit will add a CDL Listener that will replace the model
callback.
We remove the registration of all the migrated work types but CDL was
misbehaving.  The reason is because the indexer and the form was
inheriting from the wrong parent and the controller was not following
the same pattern.
The collection factory was failing because we overrode the
basic_metadata.yaml which it also uses so we need to add all the basic
metadata into the collection_resource.yaml.  There was a log that was
failing because it was not being explicit in the root of the application
though I'm unsure if it is needed.  The major question is if we need to
run hyku_specs or not.
@kirkkwang kirkkwang merged commit 1647043 into main May 21, 2024
2 of 6 checks passed
@kirkkwang kirkkwang deleted the review-knapsacking-effort branch May 21, 2024 18:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants