sufia 7.0.0.beta4 → 7.0.0.rc1

data/app/jobs/batch_create_job.rb

@@ -8,6 +8,12 @@ class BatchCreateJob < ActiveJob::Base
 
   # This copies metadata from the passed in attribute to all of the works that
   # are members of the given upload set
+  # @param [User] user
+  # @param [Array<String>] titles
+  # @param [Array<String>] resource_types
+  # @param [Array<Sufia::UploadedFile>] uploaded_files
+  # @param [Hash] attributes attributes to apply to all works
+  # @param [BatchCreateOperation] log
   def perform(user, titles, resource_types, uploaded_files, attributes, log)
     log.performing!
 
@@ -23,11 +29,21 @@ class BatchCreateJob < ActiveJob::Base
       uploaded_files.each do |upload_id|
         title = [titles[upload_id]] if titles[upload_id]
         resource_type = [resource_types[upload_id]] if resource_types[upload_id]
-        attributes = attributes.merge(uploaded_files: [upload_id], title: title, resource_type: resource_type)
+        attributes = attributes.merge(uploaded_files: [upload_id],
+                                      title: title,
+                                      resource_type: resource_type)
+        model = model_to_create(attributes)
         child_log = CurationConcerns::Operation.create!(user: user,
                                                         operation_type: "Create Work",
                                                         parent: log)
-        CreateWorkJob.perform_later(user, attributes, child_log)
+        CreateWorkJob.perform_later(user, model, attributes, child_log)
       end
     end
+
+    # Override this method if you have a different rubric for choosing the model
+    # @param [Hash] attributes
+    # @return String the model to create
+    def model_to_create(attributes)
+      Sufia.config.model_to_create.call(attributes)
+    end
 end

data/app/jobs/content_depositor_change_event_job.rb

@@ -2,21 +2,28 @@
 #
 # @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 [GenericWork] generic_work the generic work to be transfered
-  # @param [User] user the user the generic work is being transfered to.
+  # @param [ActiveFedora::Base] work the work to be transfered
+  # @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(generic_work, user, reset = false)
+  def perform(work, user, reset = false)
     @reset = reset
-    super(generic_work, user)
+    super(work, user)
   end
 
   def action
-    "User #{link_to_profile work.proxy_depositor} has transferred #{link_to work.title.first, Rails.application.routes.url_helpers.curation_concerns_generic_work_path(work)} to user #{link_to_profile depositor}"
+    "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 GenericWork's stream
+  # Log the event to the work's stream
   def log_work_event(work)
     work.log_event(event)
   end

data/app/jobs/create_work_job.rb

@@ -8,9 +8,13 @@ class CreateWorkJob < ActiveJob::Base
 
   # This copies metadata from the passed in attribute to all of the works that
   # are members of the given upload set
-  def perform(user, attributes, log)
+  # @param [User] user
+  # @param [String] model
+  # @param [Hash] attributes
+  # @param [BatchCreateOperation] log
+  def perform(user, model, attributes, log)
     log.performing!
-    work = GenericWork.new
+    work = model.constantize.new
     actor = work_actor(work, user)
     status = actor.create(attributes)
     return log.success! if status

data/app/models/batch_upload_item.rb

@@ -0,0 +1,15 @@
+# This stands in for an object to be created from the BatchUploadForm.
+# It should never actually be persisted in the repository.
+# The properties on this form should be copied to a real work type.
+class BatchUploadItem < ActiveFedora::Base
+  include CurationConcerns::BasicMetadata
+
+  # This mocks out the behavior of Hydra::PCDM::PcdmBehavior
+  def in_collection_ids
+    []
+  end
+
+  def create_or_update
+    raise "This is a read only record"
+  end
+end

data/app/models/concerns/sufia/ability.rb

@@ -14,13 +14,13 @@ module Sufia
 
     def uploaded_file_abilities
       return unless registered_user?
-      can :create, UploadedFile
+      can :create, [UploadedFile, BatchUploadItem]
       can :destroy, UploadedFile, user: current_user
     end
 
     def proxy_deposit_abilities
       can :transfer, String do |id|
-        depositor_for_document(id) == current_user.user_key
+        user_is_depositor?(id)
       end
       can :create, ProxyDepositRequest if registered_user?
       can :accept, ProxyDepositRequest, receiving_user_id: current_user.id, status: 'pending'
@@ -57,8 +57,11 @@ module Sufia
 
     private
 
-      def depositor_for_document(document_id)
-        ::GenericWork.load_instance_from_solr(document_id).depositor
+      def user_is_depositor?(document_id)
+        CurationConcerns::WorkRelation.new.search_with_conditions(
+          id: document_id,
+          DepositSearchBuilder.depositor_field => current_user.user_key
+        ).any?
       end
   end
 end

data/app/models/concerns/sufia/user.rb

@@ -110,17 +110,6 @@ module Sufia::User
     user_key.gsub(/\./, '-dot-')
   end
 
-  def trophy_works
-    trophies.map do |t|
-      begin
-        ::GenericWork.load_instance_from_solr(t.work_id)
-      rescue ActiveFedora::ObjectNotFoundError
-        logger.error("Invalid trophy for user #{user_key} (work id #{t.work_id})")
-        nil
-      end
-    end.compact
-  end
-
   # method needed for messaging
   def mailboxer_email(_obj = nil)
     nil

data/app/models/concerns/sufia/work_behavior.rb

@@ -4,6 +4,7 @@ module Sufia
     include Sufia::ProxyDeposit
     include Sufia::Works::Trophies
     include Sufia::Works::Metadata
+    include Sufia::Works::Featured
     include Sufia::WithEvents
 
     included do

data/app/models/concerns/sufia/works/featured.rb

@@ -0,0 +1,23 @@
+module Sufia::Works
+  module Featured
+    extend ActiveSupport::Concern
+    included do
+      before_destroy :cleanup_featured_works
+      after_save :check_featureability
+    end
+
+    def cleanup_featured_works
+      FeaturedWork.destroy_all(work_id: id)
+    end
+
+    def check_featureability
+      return unless private?
+      cleanup_featured_works if featured?
+    end
+
+    def featured?
+      return true if FeaturedWork.find_by_work_id(id)
+      false
+    end
+  end
+end

data/app/models/file_download_stat.rb

@@ -1,17 +1,14 @@
-class FileDownloadStat < ActiveRecord::Base
-  extend Sufia::FileStatUtils
-
-  def to_flot
-    [self.class.convert_date(date), downloads]
-  end
-
-  def self.statistics(file_id, start_date, user_id = nil)
-    combined_stats file_id, start_date, :downloads, :totalEvents, user_id
-  end
+class FileDownloadStat < Sufia::Statistic
+  self.cache_column = :downloads
+  self.event_type = :totalEvents
 
   # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download
   # see Legato::ProfileMethods.method_name_from_klass
-  def self.ga_statistics(start_date, file_id)
-    Sufia::Analytics.profile.sufia__download(sort: 'date', start_date: start_date, end_date: Date.yesterday).for_file(file_id)
+  def self.ga_statistics(start_date, file)
+    Sufia::Analytics.profile.sufia__download(sort: 'date', start_date: start_date, end_date: Date.yesterday).for_file(file.id)
+  end
+
+  def self.filter(file)
+    { file_id: file.id }
   end
 end

data/app/models/file_view_stat.rb

@@ -1,18 +1,8 @@
-class FileViewStat < ActiveRecord::Base
-  extend Sufia::FileStatUtils
+class FileViewStat < Sufia::Statistic
+  self.cache_column = :views
+  self.event_type = :pageviews
 
-  def to_flot
-    [self.class.convert_date(date), views]
-  end
-
-  def self.statistics(file_id, start_date, user_id = nil)
-    combined_stats file_id, start_date, :views, :pageviews, user_id
-  end
-
-  # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download
-  # see Legato::ProfileMethods.method_name_from_klass
-  def self.ga_statistics(start_date, file_id)
-    path = Rails.application.routes.url_helpers.curation_concerns_file_set_path(file_id)
-    Sufia::Analytics.profile.sufia__pageview(sort: 'date', start_date: start_date).for_path(path)
+  def self.filter(file)
+    { file_id: file.id }
   end
 end

data/app/models/proxy_deposit_request.rb

@@ -56,7 +56,7 @@ class ProxyDepositRequest < ActiveRecord::Base
 
   # @param [TrueClass,FalseClass] reset (false)  if true, reset the access controls. This revokes edit access from the depositor
   def transfer!(reset = false)
-    ContentDepositorChangeEventJob.perform_later(generic_work, receiving_user, reset)
+    ContentDepositorChangeEventJob.perform_later(work, receiving_user, reset)
     self.status = 'accepted'
     self.fulfillment_date = Time.current
     save!
@@ -80,21 +80,21 @@ class ProxyDepositRequest < ActiveRecord::Base
   end
 
   def deleted_work?
-    !GenericWork.exists?(work_id)
+    !work_relation.exists?(work_id)
   end
 
-  def generic_work
-    @generic_work ||= GenericWork.find(work_id)
+  def work
+    @work ||= work_relation.find(work_id)
   end
 
   # Delegate to the SolrDocument of the work
-  delegate :to_s, to: :work
+  delegate :to_s, to: :solr_doc
 
   private
 
-    def work
+    def solr_doc
       return 'work not found' if deleted_work?
-      @work ||= SolrDocument.new(solr_response['response']['docs'].first, solr_response)
+      @solr_doc ||= SolrDocument.new(solr_response['response']['docs'].first, solr_response)
     end
 
     def solr_response
@@ -104,4 +104,8 @@ class ProxyDepositRequest < ActiveRecord::Base
     def query
       ActiveFedora::SolrQueryBuilder.construct_query_for_ids([work_id])
     end
+
+    def work_relation
+      CurationConcerns::WorkRelation.new
+    end
 end

data/app/models/sufia/statistic.rb

@@ -0,0 +1,65 @@
+module Sufia
+  class Statistic < ActiveRecord::Base
+    self.abstract_class = true
+
+    class_attribute :cache_column, :event_type
+
+    class << self
+      include ActionDispatch::Routing::PolymorphicRoutes
+      include Rails.application.routes.url_helpers
+
+      def statistics_for(object)
+        where(filter(object))
+      end
+
+      def build_for(object, attrs)
+        new attrs.merge(filter(object))
+      end
+
+      def to_flots(stats)
+        stats.map(&:to_flot)
+      end
+
+      def convert_date(date_time)
+        date_time.to_datetime.to_i * 1000
+      end
+
+      def statistics(object, start_date, user_id = nil)
+        combined_stats object, start_date, cache_column, event_type, user_id
+      end
+
+      # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download
+      # see Legato::ProfileMethods.method_name_from_klass
+      def ga_statistics(start_date, object)
+        path = polymorphic_path(object)
+        Sufia::Analytics.profile.sufia__pageview(sort: 'date', start_date: start_date).for_path(path)
+      end
+
+      private
+
+        def cached_stats(object, start_date, _method)
+          stats = statistics_for(object).order(date: :asc)
+          ga_start_date = stats.any? ? stats[stats.size - 1].date + 1.day : start_date.to_date
+          { ga_start_date: ga_start_date, cached_stats: stats.to_a }
+        end
+
+        def combined_stats(object, start_date, object_method, ga_key, user_id = nil)
+          stat_cache_info = cached_stats(object, start_date, object_method)
+          stats = stat_cache_info[:cached_stats]
+          if stat_cache_info[:ga_start_date] < Time.zone.today
+            ga_stats = ga_statistics(stat_cache_info[:ga_start_date], object)
+            ga_stats.each do |stat|
+              lstat = build_for(object, date: stat[:date], object_method => stat[ga_key], user_id: user_id)
+              lstat.save unless Date.parse(stat[:date]) == Time.zone.today
+              stats << lstat
+            end
+          end
+          stats
+        end
+    end
+
+    def to_flot
+      [self.class.convert_date(date), send(cache_column)]
+    end
+  end
+end

data/app/models/work_view_stat.rb

@@ -1,19 +1,8 @@
-class WorkViewStat < ActiveRecord::Base
-  extend Sufia::WorkStatUtils
+class WorkViewStat < Sufia::Statistic
+  self.cache_column = :work_views
+  self.event_type = :pageviews
 
-  def to_flot
-    [self.class.convert_date(date), work_views]
-  end
-
-  def self.statistics(work_id, start_date, user_id = nil)
-    combined_stats work_id, start_date, :work_views, :pageviews, user_id
-  end
-
-  # Sufia::Download is sent to Sufia::Analytics.profile as #sufia__download
-  # see Legato::ProfileMethods.method_name_from_klass
-  def self.ga_statistics(start_date, work_id)
-    path = Rails.application.routes.url_helpers.curation_concerns_generic_work_path(work_id)
-
-    Sufia::Analytics.profile.sufia__pageview(sort: 'date', start_date: start_date).for_path(path)
+  def self.filter(work)
+    { work_id: work.id }
   end
 end

data/app/presenters/file_usage.rb

@@ -1,5 +1,5 @@
 class FileUsage
-  attr_accessor :id, :created, :path, :downloads, :pageviews
+  attr_accessor :id, :created, :downloads, :pageviews
 
   def initialize(id)
     file = ::FileSet.find(id)
@@ -7,10 +7,9 @@ class FileUsage
     user_id = user ? user.id : nil
 
     self.id = id
-    self.path = Rails.application.routes.url_helpers.curation_concerns_file_set_path(id)
     self.created = date_for_analytics(file)
-    self.downloads = FileDownloadStat.to_flots FileDownloadStat.statistics(id, created, user_id)
-    self.pageviews = FileViewStat.to_flots FileViewStat.statistics(id, created, user_id)
+    self.downloads = FileDownloadStat.to_flots FileDownloadStat.statistics(file, created, user_id)
+    self.pageviews = FileViewStat.to_flots FileViewStat.statistics(file, created, user_id)
   end
 
   # file.date_uploaded reflects the date the file was uploaded by the user

data/app/presenters/sufia/file_set_presenter.rb

@@ -45,9 +45,7 @@ module Sufia
     end
 
     def audit_service
-      # model = solr_document.to_model # See https://github.com/projecthydra-labs/hydra-pcdm/issues/197
-      model = FileSet.find(id)
-      @audit_service ||= CurationConcerns::FileSetAuditService.new(model)
+      @audit_service ||= CurationConcerns::FileSetAuditService.new(id)
     end
   end
 end

data/app/presenters/sufia/trophy_presenter.rb

@@ -0,0 +1,28 @@
+module Sufia
+  class TrophyPresenter
+    include CurationConcerns::ModelProxy
+    def initialize(solr_document)
+      @solr_document = solr_document
+    end
+
+    attr_reader :solr_document
+
+    delegate :to_s, to: :solr_document
+
+    def self.find_by_user(user)
+      work_ids = user.trophies.pluck(:work_id)
+      query = ActiveFedora::SolrQueryBuilder.construct_query_for_ids(work_ids)
+      results = CurationConcerns::WorkRelation.new.search_with_conditions(query)
+      results.map { |result| TrophyPresenter.new(document_model.new(result)) }
+    end
+
+    def thumbnail_path
+      solr_document[CatalogController.blacklight_config.index.thumbnail_field]
+    end
+
+    def self.document_model
+      CatalogController.blacklight_config.document_model
+    end
+    private_class_method :document_model
+  end
+end

data/app/presenters/sufia/user_profile_presenter.rb

@@ -23,7 +23,7 @@ module Sufia
     end
 
     def trophies
-      @trophies ||= user.trophy_works
+      @trophies ||= Sufia::TrophyPresenter.find_by_user(user)
     end
   end
 end