hyrax 3.2.0 → 3.3.0

data/app/services/hyrax/characterization/valkyrie_characterization_service.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+class Hyrax::Characterization::ValkyrieCharacterizationService
+  ##
+  # @api public
+  # @param [Hyrax::FileMetadata] metadata  which has properties to recieve characterization values
+  # @param [Valkyrie::StorageAdapter::StreamFile] source to run characterization against
+  # @param [Hash] options the options pass to characterization
+  # @option options [Hash{Symbol => Symbol}] parser_mapping
+  # @option options [Hydra::Works::Characterization::FitsDocument] parser
+  # @option options [Symbol] ch12n_tool
+  #
+  # @return [void]
+  def self.run(metadata:, file:, user: ::User.system_user, **options)
+    new(metadata: metadata, file: file, **options).characterize
+    saved = Hyrax.persister.save(resource: metadata)
+    Hyrax.publisher.publish('object.metadata.updated', object: saved, user: user)
+  end
+
+  ##
+  # @!attribute [rw] source
+  #   @return [Valkyrie::StorageAdapter::StreamFile]
+  # @!attribute [rw] metadata
+  #   @return [Hyrax::FileMetadata]
+  # @!attribute [rw] parser
+  #   @return [Hydra::Works::Characterization::FitsDocument]
+  # @!attribute [rw] source
+  #   @return [Valkyrie::StorageAdapter::StreamFile]
+  # @!attribute [rw] tools
+  #   @todo clarify what this is for. it gets passed to {#characterize}
+  #     on the characterizer, but it's not clear how to customize
+  #     effectively.
+  #   @return [Symbol]
+  attr_accessor :mapping, :metadata, :parser, :source, :tools
+
+  ##
+  # @api private
+  def initialize(metadata:, # rubocop:disable Metrics/ParameterLists
+                 file:,
+                 characterizer: Hydra::FileCharacterization,
+                 parser_mapping: Hydra::Works::Characterization.mapper,
+                 parser: Hydra::Works::Characterization::FitsDocument.new)
+    @characterizer = characterizer
+    @metadata      = metadata
+    @source        = file
+    @mapping       = parser_mapping
+    @parser        = parser
+    @tools         = :fits
+  end
+
+  ##
+  # @api private
+  #
+  # Coerce given source into a type that can be passed to Hydra::FileCharacterization
+  # Use Hydra::FileCharacterization to extract metadata (an OM XML document)
+  # Get the terms (and their values) from the extracted metadata
+  # Assign the values of the terms to the properties of the metadata object
+  #
+  # @return [void]
+  def characterize
+    terms = parse_metadata(extract_metadata(content))
+    apply_metadata(terms)
+  end
+
+  protected
+
+  def content
+    source.rewind
+    source.read
+  end
+
+  def extract_metadata(content)
+    @characterizer.characterize(content, file_name, tools) do |cfg|
+      cfg[:fits] = Hydra::Derivatives.fits_path
+    end
+  end
+
+  def file_name
+    metadata.original_filename
+  end
+
+  def parse_metadata(metadata)
+    doc = parser
+    doc.ng_xml = Nokogiri::XML(metadata) if metadata.present?
+    doc.__cleanup__ if doc.respond_to? :__cleanup__
+    characterization_terms(doc)
+  end
+
+  # Get proxy terms and values from the parser
+  def characterization_terms(doc)
+    h = {}
+
+    doc.class.terminology.terms.each_pair do |key, _target|
+      begin
+        h[key] = doc.public_send(key)
+      rescue NoMethodError
+        next
+      end
+    end
+
+    h.compact
+  end
+
+  # Assign values of the instance properties from the metadata mapping :prop => val
+  # @return [Hash]
+  def apply_metadata(terms)
+    terms.each_pair do |term, value|
+      property = property_for(term)
+      next if property.nil?
+
+      Array(value).each { |v| append_property_value(property, v) }
+    end
+  end
+
+  # Check parser_config then self for matching term.
+  # Return property symbol or nil
+  def property_for(term)
+    if mapping.key?(term) && metadata.respond_to?(mapping[term])
+      mapping[term]
+    elsif metadata.respond_to?(term)
+      term
+    end
+  end
+
+  ##
+  # @todo push exceptional per-property behavior into the mapping somehow?
+  def append_property_value(property, value)
+    # We don't want multiple mime_types; this overwrites each time to accept last value
+    value = Array(metadata.public_send(property)) + [value] unless property == :mime_type
+    # We don't want multiple heights / widths, pick the max
+    value = value.map(&:to_i).max.to_s if property == :height || property == :width
+    metadata.public_send("#{property}=", value)
+  end
+end

data/app/services/hyrax/collections/nested_collection_query_service.rb

@@ -111,6 +111,9 @@ module Hyrax
       def self.clean_lucene_error(builder:)
         # TODO: Need to investigate further to understand why these particular queries
         # using the where cause fail when others in the app apparently work
+        #
+        # Perhaps see <https://github.com/projectblacklight/blacklight/blob/064302f73eee4baae4d2abf863c68317d3efb5b7/lib/blacklight/solr/search_builder_behavior.rb#L84-L102>.
+        # This can be averted by using #with in at least some cases?
         query = builder.query.to_hash
         query['q'] = query['q'].gsub('{!lucene}', '') if query.key?('q')
         query
@@ -175,9 +178,11 @@ module Hyrax
         # => 1) First we find all the collections with this child in the path, sort the results in descending order, and take the first result.
         # note: We need to include works in this search. They are included in the depth validations in
         # the indexer, so we do NOT use collection search builder here.
-        builder = Hyrax::SearchBuilder.new(scope).where("#{Samvera::NestingIndexer.configuration.solr_field_name_for_storing_pathnames}:/.*#{child.id}.*/")
-        builder.query[:sort] = "#{Samvera::NestingIndexer.configuration.solr_field_name_for_deepest_nested_depth} desc"
-        builder.query[:rows] = 1
+        builder = Hyrax::SearchBuilder.new(scope).with({
+                                                         q: "#{Samvera::NestingIndexer.configuration.solr_field_name_for_storing_pathnames}:/.*#{child.id}.*/",
+                                                         sort: "#{Samvera::NestingIndexer.configuration.solr_field_name_for_deepest_nested_depth} desc"
+                                                       })
+        builder.rows = 1
         query = clean_lucene_error(builder: builder)
         response = scope.repository.search(query).documents.first
 

data/app/services/hyrax/listeners/acl_index_listener.rb

@@ -11,7 +11,9 @@ module Hyrax
       ##
       # Re-index the resource for the updated ACL.
       #
-      # @param event [Dry::Event]
+      # Called when 'object.acl.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_acl_updated(event)
         return unless event[:result] == :success # do nothing on failure
         Hyrax.index_adapter.save(resource: event[:acl].resource)

data/app/services/hyrax/listeners/active_fedora_acl_index_listener.rb

@@ -11,7 +11,9 @@ module Hyrax
       ##
       # Re-index the resource for the updated ACL.
       #
-      # @param event [Dry::Event]
+      # Called when 'object.acl.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_acl_updated(event)
         return if Hyrax.config.disable_wings
         return unless event[:result] == :success # do nothing on failure

data/app/services/hyrax/listeners/batch_notification_listener.rb

@@ -8,7 +8,9 @@ module Hyrax
       ##
       # Notify requesting users of batch success/failure
       #
-      # @param event [Dry::Event]
+      # Called when 'batch.created' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_batch_created(event)
         case event[:result]
         when :success

data/app/services/hyrax/listeners/file_metadata_listener.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Listeners
+    ##
+    # Listens for events related to Hyrax::FileMetadata
+    class FileMetadataListener
+      ##
+      # Called when 'object.file.uploaded' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
+      def on_object_file_uploaded(event)
+        Hyrax.config
+             .characterization_service
+             .run(metadata: event[:metadata], file: event[:metadata].file)
+      end
+    end
+  end
+end

data/app/services/hyrax/listeners/file_set_lifecycle_listener.rb

@@ -6,13 +6,17 @@ module Hyrax
     # Listens for events related to Hydra Works FileSets
     class FileSetLifecycleListener
       ##
-      # @param event [Dry::Event]
+      # Called when 'file.set.attached' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_file_set_attached(event)
         FileSetAttachedEventJob.perform_later(event[:file_set], event[:user])
       end
 
       ##
-      # @param event [Dry::Event]
+      # Called when 'file.set.restored' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_file_set_restored(event)
         ContentRestoredVersionEventJob
           .perform_later(event[:file_set], event[:user], event[:revision])

data/app/services/hyrax/listeners/file_set_lifecycle_notification_listener.rb

@@ -9,7 +9,9 @@ module Hyrax
       ##
       # Send a notification to the depositor for failed checksum audits.
       #
-      # @param event [Dry::Event]
+      # Called when 'file.set.audited' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_file_set_audited(event)
         return unless event[:result] == :failure # do nothing on success
 
@@ -24,7 +26,9 @@ module Hyrax
       # Send a notification to the depositing user for FileSet url import
       # failures.
       #
-      # @param event [Dry::Event]
+      # Called when 'file.set.url.imported' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_file_set_url_imported(event)
         Hyrax::ImportUrlFailureService.new(event[:file_set], event[:user]).call if
           event[:result] == :failure

data/app/services/hyrax/listeners/member_cleanup_listener.rb

@@ -5,6 +5,9 @@ module Hyrax
     ##
     # Listens for object deleted events and cleans up associated members
     class MemberCleanupListener
+      # Called when 'object.deleted' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deleted(event)
         return unless event.payload.key?(:object) # legacy callback
         return if event[:object].is_a?(ActiveFedora::Base) # handled by legacy code

data/app/services/hyrax/listeners/metadata_index_listener.rb

@@ -14,7 +14,9 @@ module Hyrax
       ##
       # Re-index the resource.
       #
-      # @param event [Dry::Event]
+      # Called when 'collection.metadata.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_collection_metadata_updated(event)
         return unless resource? event[:collection]
         Hyrax.index_adapter.save(resource: event[:collection])
@@ -23,7 +25,9 @@ module Hyrax
       ##
       # Re-index the resource.
       #
-      # @param event [Dry::Event]
+      # Called when 'object.metadata.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_metadata_updated(event)
         return unless resource? event[:object]
         Hyrax.index_adapter.save(resource: event[:object])
@@ -32,7 +36,9 @@ module Hyrax
       ##
       # Remove the resource from the index.
       #
-      # @param event [Dry::Event]
+      # Called when 'object.deleted' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deleted(event)
         return unless resource?(event.payload[:object])
         Hyrax.index_adapter.delete(resource: event[:object])

data/app/services/hyrax/listeners/object_lifecycle_listener.rb

@@ -6,19 +6,25 @@ module Hyrax
     # Listens for events related to the PCDM Object lifecycles.
     class ObjectLifecycleListener
       ##
-      # @param event [Dry::Event]
+      # Called when 'object.deleted' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deleted(event)
         ContentDeleteEventJob.perform_later(event[:id].to_s, event[:user])
       end
 
       ##
-      # @param event [Dry::Event]
+      # Called when 'object.deposited' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deposited(event)
         ContentDepositEventJob.perform_later(event[:object], event[:user])
       end
 
       ##
-      # @param event [Dry::Event]
+      # Called when 'object.metadata.updated' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_metadata_updated(event)
         ContentUpdateEventJob.perform_later(event[:object], event[:user])
       end

data/app/services/hyrax/listeners/proxy_deposit_listener.rb

@@ -7,7 +7,9 @@ module Hyrax
     # deposits an item `on_behalf_of` another, ensures transfer is handled.
     class ProxyDepositListener
       ##
-      # @param event [Dry::Event]
+      # Called when 'object.deposited' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deposited(event)
         return if event[:object].try(:on_behalf_of).blank? ||
                   (event[:object].on_behalf_of == event[:object].depositor)

data/app/services/hyrax/listeners/trophy_cleanup_listener.rb

@@ -5,6 +5,9 @@ module Hyrax
     ##
     # Listens for object deleted events and cleans up associated members
     class TrophyCleanupListener
+      # Called when 'object.deleted' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deleted(event)
         Trophy.where(work_id: event[:id]).destroy_all
       rescue StandardError => err

data/app/services/hyrax/listeners/workflow_listener.rb

@@ -21,7 +21,9 @@ module Hyrax
       end
 
       ##
-      # @param event [Dry::Event]
+      # Called when 'object.deposited' event is published
+      # @param [Dry::Events::Event] event
+      # @return [void]
       def on_object_deposited(event)
         return Rails.logger.warn("Skipping workflow initialization for #{event[:object]}; no user is given\n\t#{event}") if
           event[:user].blank?

data/app/services/hyrax/listeners.rb

@@ -7,11 +7,19 @@ module Hyrax
   #
   #    You may need to register a listener as autoload.  See
   #    ./app/services/hyrax/listeners.rb
+  #
+  # When an instance of a listener class is registered with
+  # Dry::Events::Publisher#subscribe, its method(s) will be called when a event
+  # is published that maps to the method name using the pattern:
+  #   on_event_fired => 'event.fired'
+  #
+  # @see https://dry-rb.org/gems/dry-events/0.2/#event-listeners
   module Listeners
     extend ActiveSupport::Autoload
 
     autoload :AclIndexListener
     autoload :BatchNotificationListener
+    autoload :FileMetadataListener
     autoload :FileSetLifecycleListener
     autoload :FileSetLifecycleNotificationListener
     autoload :MemberCleanupListener

data/app/services/hyrax/restriction_service.rb

@@ -2,6 +2,10 @@
 module Hyrax
   class RestrictionService
     class << self
+      ##
+      # @note needed to construct SearchBuilders using self in Blacklight 7+
+      delegate :blacklight_config, to: :config
+
       private
 
       def presenter_class

data/app/services/hyrax/statistics/users/over_time.rb

@@ -8,9 +8,8 @@ module Hyrax
           Enumerator.new(size) do |y|
             x = @x_min
             while x <= @x_max
-              bottom = x
+              y.yield [@x_output.call(x), point(x)]
               x += @delta_x.days
-              y.yield [@x_output.call(x), point(bottom, x)]
             end
           end
         end
@@ -21,9 +20,13 @@ module Hyrax
           ::User.registered
         end
 
-        # Override to make an activerecord date range query
-        def query(min, max)
-          { created_at: min..max }
+        # Overridden to search one day at a time
+        def query(date_string)
+          { created_at: date_string.to_date.beginning_of_day..date_string.to_date.end_of_day }
+        end
+
+        def point(date_string)
+          relation.where(query(date_string)).count
         end
       end
     end

data/app/services/hyrax/statistics/works/over_time.rb

@@ -3,6 +3,16 @@ module Hyrax
   module Statistics
     module Works
       class OverTime < Statistics::OverTime
+        def points
+          Enumerator.new(size) do |y|
+            x = @x_min
+            while x <= @x_max
+              y.yield [@x_output.call(x), point(@x_min, x)]
+              x += @delta_x.days
+            end
+          end
+        end
+
         private
 
         def relation

data/app/services/hyrax/work_uploads_handler.rb

@@ -114,8 +114,11 @@ module Hyrax
       file_set.permission_manager.acl.save if file_set.permission_manager.acl.pending_changes?
       append_to_work(file_set)
 
-      IngestJob.perform_later(wrap_file(file, file_set))
+      ValkyrieIngestJob.perform_later(file)
+
+      # this triggers the re-index
       Hyrax.publisher.publish('object.metadata.updated', object: file_set, user: file.user)
+
       { file_set: file_set, user: file.user }
     end
 

data/app/views/hyrax/admin/analytics/_date_range_form.html.erb

@@ -0,0 +1,11 @@
+<div class="panel panel-default">
+  <div class="panel-heading"><h4><%= t('.date_range_heading') %></h4></div>
+  <div class="panel-body">
+    <%= form_tag(redirect_path, method: :get, class: "form-inline") do %>
+      <%= t('.start_date') %>: <%= date_field_tag :start_date, "", class: 'datepicker form-control', placeholder: 'mm/dd/yyyy', required: true %>
+      <%= t('.end_date') %>: <%= date_field_tag :end_date, "", class: 'datepicker form-control', placeholder: 'mm/dd/yyyy', required: true %>
+      <%= submit_tag "#{t('.set_date_range')}", class: 'btn btn-primary' %>
+      <%= link_to "#{t('.reset_date_range')}", redirect_path if params[:start_date] %>
+    <% end %>
+  </div>
+</div>

data/app/views/hyrax/admin/analytics/collection_reports/_custom_range.html.erb

@@ -0,0 +1,39 @@
+<div class="panel panel-default">
+  <div class="panel-heading"><h4><%= t('.summary_heading') %></h4></div>
+  <div class="panel-body">
+    <table class="table table-striped">
+      <thead>
+        <tr>
+          <th>&nbsp;</th>
+          <th><%= @start_date.to_date.strftime("%B %d, %Y") %> through <%= @end_date.to_date.strftime("%B %d, %Y") %></th>
+        </tr>
+      </thead>
+            <tbody>
+        <% if @pageviews %>
+          <tr>
+            <td><b><%= t('.collection_home_page_views') %></b></td>
+            <td><%= @pageviews.range(@start_date.to_date, @end_date.to_date) %></td>
+          </tr>
+        <% end %>
+        <% if @work_page_views %>
+          <tr>
+            <td><b><%= t('.work_views') %></b></td>
+            <td><%= @work_page_views.range(@start_date.to_date, @end_date.to_date) %></td>
+          </tr>
+        <% end %>
+        <% if @downloads %>
+          <tr>
+            <td><b><%= t('.work_downloads') %></b></td>
+            <td><%= @downloads.range(@start_date.to_date, @end_date.to_date) %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+
+<% if params[:start_date] %>
+  <% if @top_collections %>
+    <%= render 'top_collections' %>
+  <% end %>
+<% end %>

data/app/views/hyrax/admin/analytics/collection_reports/_monthly_summary.html.erb

@@ -0,0 +1,48 @@
+<div class="panel panel-default">
+  <div class="panel-heading">
+    <h4><%= t('.monthly_subtitle') %> <%= Time.zone.today.strftime("%B %Y") %></h4>
+  </div>
+  <div class="panel-body">
+    <table class="table table-striped">
+      <thead>
+      <tr>
+        <th>&nbsp;</th>
+        <% @month_names.each do |name| %>
+          <th><%= name %></th>
+        <% end %>
+      </tr>
+      </thead>
+      <tbody>
+      <% if @pageviews %>    
+        <tr>
+          <td><b><%= t('.collection_views') %></b></td>
+          <% @month_names.each do |name| %>
+            <td><%= @pageviews.month(name.to_date) %></td>
+          <% end %>
+        </tr>
+      <% end %>
+      <% if @work_page_views %>
+        <tr>
+          <td><b><%= t('.work_views') %></b></td>
+            <% @month_names.each do |name| %>
+            <td><%= @work_page_views.month(name.to_date) %></td>
+          <% end %>
+        </tr>
+      <% end %>
+      <% if @downloads %>
+        <tr>
+          <td><b><%= t('.work_downloads') %></b></td>
+            <% @month_names.each do |name| %>
+            <td><%= @downloads.month(name.to_date) %></td>
+          <% end %>
+        </tr>
+      <% end %>
+      
+      </tbody>
+    </table>
+  </div>
+</div>
+
+
+
+

data/app/views/hyrax/admin/analytics/collection_reports/_summary.html.erb

@@ -0,0 +1,55 @@
+<div class="panel panel-default">
+  <div class="panel-heading">
+  <h4><%= t('.subtitle')%></h4>
+  </div>
+  <div class="panel-body">
+    <table class="table table-striped">
+      <thead>
+        <tr>
+          <th>&nbsp;</th>
+          <th><%= t('.today') %></th>
+          <th><%= t('.this_week') %></th>
+          <th><%= t('.this_month') %></th>
+          <th><%= t('.this_year') %></th>
+          <th><%= t('.all_time') %></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% if @pageviews %>
+          <tr>
+            <td><b><%= t('.collection_home_page_views') %></b></td>
+            <td><%= @pageviews.day %></td>
+            <td><%= @pageviews.week %></td>
+            <td><%= @pageviews.month %></td>
+            <td><%= @pageviews.year %></td>
+            <td><%= @pageviews.all %></td>
+          </tr>
+        <% end %>
+        <% if @work_page_views %>
+          <tr>
+            <td><b><%= t('.work_views') %></b></td>
+            <td><%= @work_page_views.day %></td>
+            <td><%= @work_page_views.week %></td>
+            <td><%= @work_page_views.month %></td>
+            <td><%= @work_page_views.year %></td>
+            <td><%= @work_page_views.all %></td>
+          </tr>
+        <% end %>
+        <% if @downloads %>
+          <tr>
+            <td><b><%= t('.work_downloads') %></b></td>
+            <td><%= @downloads.day %></td>
+            <td><%= @downloads.week %></td>
+            <td><%= @downloads.month %></td>
+            <td><%= @downloads.year %></td>
+            <td><%= @downloads.all %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+
+<% if @top_collections %>
+  <%= render 'top_collections' %>
+<% end %>