hyrax 3.6.0 → 4.0.0.beta1

data/app/actors/hyrax/actors/initialize_workflow_actor.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Actors
-    ##
-    # @deprecated
-    #
-    # Responsible for generating the workflow for the given curation_concern.
-    # Done through direct collaboration with the configured Hyrax::Actors::InitializeWorkflowActor.workflow_factory
-    #
-    # @see Hyrax::Actors::InitializeWorkflowActor.workflow_factory
-    # @see Hyrax::Workflow::WorkflowFactory for default workflow factory
-    class InitializeWorkflowActor < AbstractActor
-      class_attribute :workflow_factory
-      self.workflow_factory = ::Hyrax::Workflow::WorkflowFactory
-
-      # @param [Hyrax::Actors::Environment] env
-      # @return [Boolean] true if create was successful
-      def create(env)
-        Deprecation.warn('Use Hyrax::Listeners::WorkflowListener instead.')
-        next_actor.create(env) && create_workflow(env)
-      end
-
-      private
-
-      # @return [TrueClass]
-      def create_workflow(env)
-        # if the entity exists, this is already initialized
-        Sipity::Entity(env.curation_concern)
-        true
-      rescue Sipity::ConversionError
-        workflow_factory.create(env.curation_concern, env.attributes, env.user)
-      end
-    end
-  end
-end

data/app/forms/hyrax/forms/embargo.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Forms
-    ##
-    # Nested form for embargos.
-    class Embargo < Hyrax::ChangeSet
-      property :visibility_after_embargo
-      property :visibility_during_embargo
-      property :embargo_release_date
-      property :embargo_history, default: []
-    end
-  end
-end

data/app/forms/hyrax/forms/lease.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Forms
-    ##
-    # Nested form for leases.
-    class Lease < Hyrax::ChangeSet
-      property :visibility_after_lease
-      property :visibility_during_lease
-      property :lease_expiration_date
-      property :lease_history, default: []
-    end
-  end
-end

data/app/forms/hyrax/forms/pcdm_object_form.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Hyrax
-  module Forms
-    ##
-    # A form for PCDM objects: resources which have collection relationships and
-    # generally resemble +Hyrax::Work+.
-    class PcdmObjectForm < Hyrax::Forms::ResourceForm
-      include Hyrax::FormFields(:core_metadata)
-
-      property :on_behalf_of
-      property :proxy_depositor
-
-      # pcdm relationships
-      property :admin_set_id, prepopulator: ->(_opts) { self.admin_set_id = Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s }
-      property :member_ids, default: [], type: Valkyrie::Types::Array
-      property :member_of_collection_ids, default: [], type: Valkyrie::Types::Array
-      property :member_of_collections_attributes, virtual: true, populator: :in_collections_populator
-      validates_with CollectionMembershipValidator
-
-      property :representative_id, type: Valkyrie::Types::String
-      property :thumbnail_id, type: Valkyrie::Types::String
-      property :rendering_ids, default: [], type: Valkyrie::Types::Array
-
-      # backs the child work search element;
-      # @todo: look for a way for the view template not to depend on this
-      property :find_child_work, default: nil, virtual: true
-
-      private
-
-      def in_collections_populator(fragment:, **_options)
-        adds = []
-        deletes = []
-        fragment.each do |_, h|
-          if h["_destroy"] == "true"
-            deletes << Valkyrie::ID.new(h["id"])
-          else
-            adds << Valkyrie::ID.new(h["id"])
-          end
-        end
-
-        self.member_of_collection_ids = ((member_of_collection_ids + adds) - deletes).uniq
-      end
-    end
-  end
-end

data/app/forms/hyrax/forms/work_embargo_form.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Hyrax
-  module Forms
-    ##
-    # Represents an embargo for edit through a work. That is, this form can
-    # be used to wrap a Work in order to capture state changes related only to
-    # its embargo, ignoring the work's other fields.
-    #
-    # @note this supports the edit functionality of
-    #   +EmbargoesControllerBehavior+.
-    class WorkEmbargoForm < Hyrax::ChangeSet
-      property :embargo, form: Hyrax::Forms::Embargo, populator: :embargo_populator, prepopulator: :embargo_populator
-      property :embargo_release_date, virtual: true, prepopulator: ->(_opts) { self.embargo_release_date = model.embargo&.embargo_release_date }
-      property :visibility_after_embargo, virtual: true, prepopulator: ->(_opts) { self.visibility_after_embargo = model.embargo&.visibility_after_embargo }
-      property :visibility_during_embargo, virtual: true, prepopulator: ->(_opts) { self.visibility_during_embargo = model.embargo&.visibility_during_embargo }
-
-      def embargo_populator(**)
-        self.embargo = Hyrax::EmbargoManager.embargo_for(resource: model)
-      end
-
-      ##
-      # @return [String]
-      def human_readable_type
-        model.to_model.human_readable_type
-      end
-
-      ##
-      # @return [ActiveModel::Name]
-      def model_name
-        model.to_model.model_name
-      end
-    end
-  end
-end

data/app/forms/hyrax/forms/work_lease_form.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Hyrax
-  module Forms
-    ##
-    # Represents a lease for edit through a work. That is, this form can
-    # be used to wrap a Work in order to capture state changes related only to
-    # its lease, ignoring the work's other fields.
-    #
-    # @note this supports the edit functionality of
-    #   +LeasesControllerBehavior+.
-    class WorkLeaseForm < Hyrax::ChangeSet
-      property :lease, form: Hyrax::Forms::Lease, populator: :lease_populator, prepopulator: :lease_populator
-      property :lease_expiration_date, virtual: true, prepopulator: ->(_opts) { self.lease_expiration_date = model.lease&.lease_expiration_date }
-      property :visibility_after_lease, virtual: true, prepopulator: ->(_opts) { self.visibility_after_lease = model.lease&.visibility_after_lease }
-      property :visibility_during_lease, virtual: true, prepopulator: ->(_opts) { self.visibility_during_lease = model.lease&.visibility_during_lease }
-
-      def lease_populator(**)
-        self.lease = Hyrax::LeaseManager.lease_for(resource: model)
-      end
-
-      ##
-      # @return [String]
-      def human_readable_type
-        model.to_model.human_readable_type
-      end
-
-      ##
-      # @return [ActiveModel::Name]
-      def model_name
-        model.to_model.model_name
-      end
-    end
-  end
-end

data/app/helpers/hyrax/url_helper.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module UrlHelper
-    # generated models get registered as curation concerns and need a
-    # track_model_path to render Blacklight-related views
-    (['FileSet', 'Collection', 'Hyrax::AdministrativeSet'] + Hyrax.config.registered_curation_concern_types).each do |concern|
-      model = concern.safe_constantize
-      model_name = model.respond_to?(:model_name) && model.model_name
-      next unless model_name
-      define_method("track_#{model_name.singular_route_key}_path") { |*args| main_app.track_solr_document_path(*args) }
-    end
-  end
-end

data/app/jobs/content_depositor_change_event_job.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-# Log work depositor change to activity streams
-#
-# @attr [Boolean] reset (false) should the access controls be reset. This means revoking edit access from the depositor
-class ContentDepositorChangeEventJob < ContentEventJob
-  include Rails.application.routes.url_helpers
-  include ActionDispatch::Routing::PolymorphicRoutes
-
-  attr_accessor :reset
-
-  # @param [ActiveFedora::Base, Hyrax::Work] work the work to be transferred
-  # @param [User] user the user the work is being transfered to.
-  # @param [TrueClass,FalseClass] reset (false) if true, reset the access controls. This revokes edit access from the depositor
-  def perform(work, user, reset = false)
-    Deprecation.warn("This class will be removed in the next major release. Use Hyrax::ChangeDepositorService.call instead.")
-    @reset = reset
-    super(work, user)
-  end
-
-  def action
-    "User #{link_to_profile work.proxy_depositor} has transferred #{link_to_work work.title.first} to user #{link_to_profile depositor}"
-  end
-
-  def link_to_work(text)
-    link_to text, polymorphic_path(work)
-  end
-
-  # Log the event to the work's stream
-  def log_work_event(work)
-    work.log_event(event)
-  end
-  alias log_file_set_event log_work_event
-
-  def work
-    @work ||= Hyrax::ChangeContentDepositorService.call(repo_object, depositor, reset)
-  end
-
-  # overriding default to log the event to the depositor instead of their profile
-  def log_user_event(depositor)
-    # log the event to the proxy depositor's profile
-    proxy_depositor.log_profile_event(event)
-    depositor.log_event(event)
-  end
-
-  def proxy_depositor
-    @proxy_depositor ||= ::User.find_by_user_key(work.proxy_depositor)
-  end
-end

data/app/models/concerns/hyrax/with_file_sets.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module WithFileSets
-    extend ActiveSupport::Concern
-
-    ##
-    # @deprecated Use 'Hyrax::VisibilityPropagator' instead.
-    def copy_visibility_to_files
-      Deprecation.warn "Use 'Hyrax::VisibilityPropagator' instead."
-
-      file_sets.each do |fs|
-        fs.visibility = visibility
-        fs.save!
-      end
-    end
-  end
-end

data/app/services/hyrax/analytics/ga4.rb

@@ -1,204 +0,0 @@
-# frozen_string_literal: true
-require 'oauth2'
-require 'signet/oauth_2/client'
-
-# rubocop:disable Metrics/ModuleLength
-module Hyrax
-  module Analytics
-    module Ga4
-      extend ActiveSupport::Concern
-      # rubocop:disable Metrics/BlockLength
-      class_methods do
-        # Loads configuration options from config/analytics.yml. Expected structure:
-        # `analytics:`
-        # `  ga4:`
-        # `    app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME']`
-        # `    app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION']`
-        # `    privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH']`
-        # `    privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET']`
-        # `    client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL']`
-        # @return [Config]
-        def config
-          @config ||= Config.load_from_yaml
-        end
-
-        class Config
-          def self.load_from_yaml
-            filename = Rails.root.join('config', 'analytics.yml')
-            yaml = YAML.safe_load(ERB.new(File.read(filename)).result)
-            unless yaml
-              Hyrax.logger.error("Unable to fetch any keys from #{filename}.")
-              return new({})
-            end
-            config = yaml.fetch('analytics')&.fetch('ga4', nil)
-            unless config
-              Deprecation.warn("Deprecated analytics configuration format found. Please update config/analytics.yml.")
-              config = yaml.fetch('analytics')
-              # this has to exist here with a placeholder so it can be set in the Hyrax initializer
-              # it is only for backward compatibility
-              config['analytics_id'] = '-'
-            end
-            new config
-          end
-
-          REQUIRED_KEYS = %w[analytics_id app_name app_version privkey_path privkey_secret client_email].freeze
-
-          def initialize(config)
-            @config = config
-          end
-
-          # @return [Boolean] are all the required values present?
-          def valid?
-            config_keys = @config.keys
-            REQUIRED_KEYS.all? { |required| config_keys.include?(required) }
-          end
-
-          REQUIRED_KEYS.each do |key|
-            class_eval %{ def #{key};  @config.fetch('#{key}'); end }
-          end
-
-          # This method allows setting the analytics id in the initializer
-          # @deprecated set the analytics id in either ENV['GOOGLE_ANALYTICS_ID'] or config/analytics.yaml
-          def analytics_id=(value)
-            @config['analytics_id'] = value
-          end
-        end
-
-        # Generate an OAuth2 token for Google Analytics
-        # @return [OAuth2::AccessToken] An OAuth2 access token for GA
-        def token(scope = 'https://www.googleapis.com/auth/analytics.readonly')
-          access_token = auth_client(scope).fetch_access_token!
-          OAuth2::AccessToken.new(oauth_client, access_token['access_token'], expires_in: access_token['expires_in'])
-        end
-
-        def oauth_client
-          OAuth2::Client.new('', '', authorize_url: 'https://accounts.google.com/o/oauth2/auth',
-                                     token_url: 'https://accounts.google.com/o/oauth2/token')
-        end
-
-        def auth_client(scope)
-          raise "Private key file for Google analytics was expected at '#{config.privkey_path}', but no file was found." unless File.exist?(config.privkey_path)
-          private_key = File.read(config.privkey_path)
-          Signet::OAuth2::Client.new token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
-                                     audience: 'https://accounts.google.com/o/oauth2/token',
-                                     scope: scope,
-                                     issuer: config.client_email,
-                                     signing_key: OpenSSL::PKCS12.new(private_key, config.privkey_secret).key,
-                                     sub: config.client_email
-        end
-
-        # Return a user object linked to a Google Analytics account
-        # @return [Legato::User] A user account with GA access
-        def user
-          Legato::User.new(token)
-        end
-
-        # Return a Google Analytics profile matching specified ID
-        # @ return [Legato::Management::Profile] A user profile associated with GA
-        def profile
-          return unless config.valid?
-          @profile = user.profiles.detect do |profile|
-            profile.web_property_id == config.analytics_id
-          end
-          raise 'User does not have access to this property' unless @profile
-          @profile
-        end
-
-        # rubocop:disable Metrics/MethodLength
-        def to_date_range(period)
-          case period
-          when "day"
-            start_date = Time.zone.today
-            end_date = Time.zone.today
-          when "week"
-            start_date = Time.zone.today - 7.days
-            end_date = Time.zone.today
-          when "month"
-            start_date = Time.zone.today - 1.month
-            end_date = Time.zone.today
-          when "year"
-            start_date = Time.zone.today - 1.year
-            end_date = Time.zone.today
-          end
-
-          [start_date, end_date]
-        end
-        # rubocop:enabl e Metrics/MethodLength
-
-        def keyword_conversion(date)
-          case date
-          when "last12"
-            start_date = Time.zone.today - 11.months
-            end_date = Time.zone.today
-
-            [start_date, end_date]
-          else
-            date.split(",")
-          end
-        end
-
-        def date_period(period, date)
-          if period == "range"
-            date.split(",")
-          else
-            to_date_range(period)
-          end
-        end
-
-        # Configure analytics_start_date in ENV file
-        def default_date_range
-          "#{Hyrax.config.analytics_start_date},#{Time.zone.today + 1.day}"
-        end
-
-        # The number of events by day for an action
-        def daily_events(action, date = default_date_range)
-          date = date.split(",")
-          EventsDaily.summary(profile, date[0], date[1], action)
-        end
-
-        # The number of events by day for an action and ID
-        def daily_events_for_id(id, action, date = default_date_range)
-          date = date.split(",")
-          EventsDaily.by_id(profile, date[0], date[1], id, action)
-        end
-
-        # A list of events sorted by highest event count
-        def top_events(action, date = default_date_range)
-          date = date.split(",")
-          Events.send('list', profile, date[0], date[1], action)
-        end
-
-        def unique_visitors(date = default_date_range); end
-
-        def unique_visitors_for_id(id, date = default_date_range); end
-
-        def new_visitors(period = 'month', date = default_date_range)
-          date = date_period(period, date)
-          Visits.new_visits(profile, date[0], date[1])
-        end
-
-        def new_visits_by_day(date = default_date_range, _period = 'day')
-          date = date.split(",")
-          VisitsDaily.new_visits(profile, date[0], date[1])
-        end
-
-        def returning_visitors(period = 'month', date = default_date_range)
-          date = date_period(period, date)
-          Visits.return_visits(profile, date[0], date[1])
-        end
-
-        def returning_visits_by_day(date = default_date_range, _period = 'day')
-          date = date.split(",")
-          VisitsDaily.return_visits(profile, date[0], date[1])
-        end
-
-        def total_visitors(period = 'month', date = default_date_range)
-          date = date_period(period, date)
-          Visits.total_visits(profile, date[0], date[1])
-        end
-      end
-      # rubocop:enable Metrics/BlockLength
-    end
-  end
-end
-# rubocop:enable Metrics/ModuleLength

data/app/services/hyrax/file_set_file_service.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Hyrax
-  ##
-  # A service for accessing specific Hyrax::FileMetadata objects referenced by a
-  # Hyrax::FileSet.
-  class FileSetFileService
-    ##
-    # @!attribute [r] file_set
-    #   @return [Hyrax::FileSet]
-    attr_reader :file_set
-
-    ##
-    # @!attribute [r] query_service
-    #   @return [#find_by]
-    attr_reader :query_service
-
-    ##
-    # @param resource [Hyrax::FileSet]
-    def initialize(file_set:, query_service: Hyrax.query_service)
-      @query_service = query_service
-      @file_set = file_set
-    end
-
-    ##
-    # Return the Hyrax::FileMetadata which should be considered “original” for
-    # indexing and version‐tracking.
-    #
-    # If +file_set.original_file_id+ is defined, it will be used; otherwise,
-    # this requires a custom query. The ultimate fallback, if no
-    # pcdm:OriginalFile is associated with the :file_set, is to just use the
-    # first file in its :file_ids.
-    #
-    # @return [Hyrax::FileMetadata]
-    def original_file
-      if file_set.original_file_id
-        # Always just use original_file_id if it is defined.
-        #
-        # NOTE: This needs to use :find_file_metadata_by, not :find_by, because
-        # at time of writing the latter does not work in Wings.
-        query_service.custom_queries.find_file_metadata_by(id: file_set.original_file_id)
-      else
-        # Cache the fallback to avoid needing to do this query twice.
-        #
-        # See NOTE above regarding use of :find_file_metadata_by.
-        @original_file ||= begin
-                             query_service.custom_queries.find_original_file(file_set: file_set)
-                           rescue Valkyrie::Persistence::ObjectNotFoundError
-                             fallback_id = file_set.file_ids.first
-                             query_service.custom_queries.find_file_metadata_by(id: fallback_id) if fallback_id
-                           end
-      end
-    end
-  end
-end

data/app/services/hyrax/work_resource_query_service.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  # Responsible for retrieving information based on the given work.
-  #
-  # @see ProxyDepositRequest
-  # @see SolrDocument
-  # @see Hyrax::SolrService
-  # @note This was extracted from the ProxyDepositRequest, which was coordinating lots of effort. It was also an ActiveRecord object that required lots of Fedora/Solr interactions.
-  class WorkResourceQueryService
-    # @param [String] id - The id of the work
-    def initialize(id:)
-      @id = id
-    end
-    attr_reader :id
-
-    # @return [Boolean] if the work has been deleted
-    def deleted_work?
-      Hyrax.query_service.find_by(id: id)
-      false
-    rescue Valkyrie::Persistence::ObjectNotFoundError
-      true
-    end
-
-    def work
-      # Need to ensure it is a work?
-      resource = Hyrax.query_service.find_by(id: id)
-      raise ModelMismatchError, "Expected work but got #{resource.class}" unless resource.work?
-      resource
-    end
-
-    def to_s
-      if deleted_work?
-        'work not found'
-      else
-        solr_doc.to_s
-      end
-    end
-
-    private
-
-    def solr_doc
-      @solr_doc ||= ::SolrDocument.new(Hyrax::SolrService.search_by_id(id))
-    end
-  end
-end

data/app/views/hyrax/admin/workflows/_tabs.html.erb

@@ -1,9 +0,0 @@
-<ul class="nav nav-tabs" id="my_nav" role="list">
-  <li<%= ' class="active"'.html_safe if @response.viewing_under_review? %>>
-      <%= link_to t('hyrax.admin.workflows.index.tabs.under_review'),
-        hyrax.admin_workflows_path(state: 'under-review'), class: "nav-link#{' active' if @response.viewing_under_review?}" %>
-  </li>
-  <li<%= ' class="active"'.html_safe if !@response.viewing_under_review? %>>
-    <%= link_to t('hyrax.admin.workflows.index.tabs.published'), hyrax.admin_workflows_path(state: 'published'), class: "nav-link#{' active' if !@response.viewing_under_review?}" %>
-  </li>
-</ul>

data/app/views/shared/_ga4.html.erb

@@ -1,10 +0,0 @@
-<!-- Google tag (gtag.js) -->
-<script async src="https://www.googletagmanager.com/gtag/js?id=<%= Hyrax::Analytics.config.analytics_id %>"></script>
-<script>
-    window.dataLayer = window.dataLayer || [];
-    function gtag(){dataLayer.push(arguments);}
-    gtag('js', new Date());
-
-    gtag('config', '<%= Hyrax::Analytics.config.analytics_id %>');
-</script>
-<meta name="analytics-provider" content="ga4">