test_hyrax 0.0.1.alpha

data/app/presenters/hyrax/admin_dashboard_presenter.rb

@@ -0,0 +1,8 @@
+module Hyrax
+  class AdminDashboardPresenter
+    # @return [Fixnum] the number of currently registered users
+    def user_count
+      ::User.where(guest: false).count
+    end
+  end
+end

data/app/presenters/hyrax/admin_set_presenter.rb

@@ -0,0 +1,7 @@
+module Hyrax
+  class AdminSetPresenter < CollectionPresenter
+    def total_items
+      ActiveFedora::SolrService.count("{!field f=isPartOf_ssim}#{id}")
+    end
+  end
+end

data/app/presenters/hyrax/admin_stats_presenter.rb

@@ -0,0 +1,54 @@
+module Hyrax
+  class AdminStatsPresenter
+    attr_reader :limit, :stats_filters
+
+    def initialize(stats_filters, limit)
+      @stats_filters = stats_filters
+      @limit = limit
+    end
+
+    def start_date
+      @start_date ||= Time.zone.parse(stats_filters[:start_date]).beginning_of_day if stats_filters[:start_date].present?
+    end
+
+    def end_date
+      @end_date ||= Time.zone.parse(stats_filters[:end_date]).end_of_day if stats_filters[:end_date].present?
+    end
+
+    def depositors
+      @depositors ||= Hyrax::Statistics::Depositors::Summary.new(start_date, end_date).depositors
+    end
+
+    def recent_users
+      @recent_users ||= stats.recent_users
+    end
+
+    def active_users
+      @active_users ||= Hyrax::Statistics::Works::ByDepositor.new(limit).query
+    end
+
+    def top_formats
+      @top_formats ||= Hyrax::Statistics::FileSets::ByFormat.new(limit).query
+    end
+
+    def works_count
+      @works_count ||= Hyrax::Statistics::Works::Count.new(start_date, end_date).by_permission
+    end
+
+    def date_filter_string
+      if start_date.blank?
+        "unfiltered"
+      elsif end_date.blank?
+        "#{start_date.to_date.to_formatted_s(:standard)} to #{Date.current.to_formatted_s(:standard)}"
+      else
+        "#{start_date.to_date.to_formatted_s(:standard)} to #{end_date.to_date.to_formatted_s(:standard)}"
+      end
+    end
+
+    private
+
+      def stats
+        @stats ||= Hyrax::Statistics::SystemStats.new(limit, start_date, end_date)
+      end
+  end
+end

data/app/presenters/hyrax/characterization_behavior.rb

@@ -0,0 +1,84 @@
+module Hyrax
+  module CharacterizationBehavior
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def characterization_terms
+        [
+          :byte_order, :compression, :height, :width, :height, :color_space,
+          :profile_name, :profile_version, :orientation, :color_map, :image_producer,
+          :capture_device, :scanning_software, :gps_timestamp, :latitude, :longitude,
+          :file_format, :file_title, :page_count, :duration, :sample_rate,
+          :format_label, :file_size, :filename, :well_formed, :last_modified,
+          :original_checksum, :mime_type
+        ]
+      end
+    end
+
+    included do
+      delegate(*characterization_terms, to: :solr_document)
+    end
+
+    def characterized?
+      !characterization_metadata.values.compact.empty?
+    end
+
+    def characterization_metadata
+      @characterization_metadata ||= build_characterization_metadata
+    end
+
+    # Override this if you want to inject additional characterization metadata
+    # Use a hash of key/value pairs where the value is an Array or String
+    # {
+    #   term1: ["value"],
+    #   term2: ["value1", "value2"],
+    #   term3: "a string"
+    # }
+    def additional_characterization_metadata
+      @additional_characterization_metadata ||= {}
+    end
+
+    def label_for_term(term)
+      term.to_s.titleize
+    end
+
+    # Returns an array of characterization values truncated to 250 characters limited
+    # to the maximum number of configured values.
+    # @param [Symbol] term found in the characterization_metadata hash
+    # @return [Array] of truncated values
+    def primary_characterization_values(term)
+      values = values_for(term)
+      values.slice!(Hyrax.config.fits_message_length, (values.length - Hyrax.config.fits_message_length))
+      truncate_all(values)
+    end
+
+    # Returns an array of characterization values truncated to 250 characters that are in
+    # excess of the maximum number of configured values.
+    # @param [Symbol] term found in the characterization_metadata hash
+    # @return [Array] of truncated values
+    def secondary_characterization_values(term)
+      values = values_for(term)
+      additional_values = values.slice(Hyrax.config.fits_message_length, values.length - Hyrax.config.fits_message_length)
+      return [] unless additional_values
+      truncate_all(additional_values)
+    end
+
+    private
+
+      def values_for(term)
+        Array.wrap(characterization_metadata[term])
+      end
+
+      def truncate_all(values)
+        values.map { |v| v.to_s.truncate(250) }
+      end
+
+      def build_characterization_metadata
+        self.class.characterization_terms.each do |term|
+          value = send(term)
+          additional_characterization_metadata[term.to_sym] = value unless value.blank?
+        end
+        additional_characterization_metadata
+      end
+  end
+end

data/app/presenters/hyrax/collection_presenter.rb

@@ -0,0 +1,57 @@
+module Hyrax
+  class CollectionPresenter
+    include ModelProxy
+    include PresentsAttributes
+    include ActionView::Helpers::NumberHelper
+    attr_accessor :solr_document, :current_ability, :request
+
+    # @param [SolrDocument] solr_document
+    # @param [Ability] current_ability
+    # @param [ActionDispatch::Request] request the http request context
+    def initialize(solr_document, current_ability, request = nil)
+      @solr_document = solr_document
+      @current_ability = current_ability
+      @request = request
+    end
+
+    # CurationConcern methods
+    delegate :stringify_keys, :human_readable_type, :collection?, :representative_id,
+             :to_s, to: :solr_document
+
+    # Metadata Methods
+    delegate :title, :description, :creator, :contributor, :subject, :publisher, :keyword, :language,
+             :embargo_release_date, :lease_expiration_date, :rights, :date_created,
+             :resource_type, :based_near, :related_url, :identifier, to: :solr_document
+
+    # Terms is the list of fields displayed by
+    # app/views/collections/_show_descriptions.html.erb
+    def self.terms
+      [:total_items, :size, :resource_type, :creator, :contributor, :keyword,
+       :rights, :publisher, :date_created, :subject, :language, :identifier,
+       :based_near, :related_url]
+    end
+
+    def terms_with_values
+      self.class.terms.select { |t| self[t].present? }
+    end
+
+    def [](key)
+      case key
+      when :size
+        size
+      when :total_items
+        total_items
+      else
+        solr_document.send key
+      end
+    end
+
+    def size
+      number_to_human_size(@solr_document['bytes_lts'])
+    end
+
+    def total_items
+      @solr_document.fetch('member_ids_ssim', []).length
+    end
+  end
+end

data/app/presenters/hyrax/composite_presenter_factory.rb

@@ -0,0 +1,22 @@
+module Hyrax
+  ##
+  # Dynamic presenter which instantiates a file set presenter if given an object
+  #   with a given ID, but otherwise instantiates a work presenter.
+  class CompositePresenterFactory
+    attr_reader :file_set_presenter_class, :work_presenter_class, :file_set_ids
+    def initialize(file_set_presenter_class, work_presenter_class, file_set_ids)
+      @file_set_presenter_class = file_set_presenter_class
+      @work_presenter_class = work_presenter_class
+      @file_set_ids = file_set_ids
+    end
+
+    def new(*args)
+      obj = args.first
+      if file_set_ids.include?(obj.id)
+        file_set_presenter_class.new(*args)
+      else
+        work_presenter_class.new(*args)
+      end
+    end
+  end
+end

data/app/presenters/hyrax/embargo_presenter.rb

@@ -0,0 +1,26 @@
+module Hyrax
+  # Presents embargoed objects
+  class EmbargoPresenter
+    include ModelProxy
+    attr_accessor :solr_document
+
+    delegate :human_readable_type, :visibility, :to_s, to: :solr_document
+
+    # @param [SolrDocument] solr_document
+    def initialize(solr_document)
+      @solr_document = solr_document
+    end
+
+    def embargo_release_date
+      Date.parse(solr_document.embargo_release_date).to_formatted_s(:rfc822)
+    end
+
+    def visibility_after_embargo
+      solr_document.fetch('visibility_after_embargo_ssim', []).first
+    end
+
+    def embargo_history
+      solr_document['embargo_history_ssim']
+    end
+  end
+end

data/app/presenters/hyrax/file_set_presenter.rb

@@ -0,0 +1,107 @@
+module Hyrax
+  class FileSetPresenter
+    include ModelProxy
+    include PresentsAttributes
+    include CharacterizationBehavior
+    include WithEvents
+
+    attr_accessor :solr_document, :current_ability, :request
+
+    # @param [SolrDocument] solr_document
+    # @param [Ability] current_ability
+    # @param [ActionDispatch::Request] request the http request context
+    def initialize(solr_document, current_ability, request = nil)
+      @solr_document = solr_document
+      @current_ability = current_ability
+      @request = request
+    end
+
+    # CurationConcern methods
+    delegate :stringify_keys, :human_readable_type, :collection?, :image?, :video?,
+             :audio?, :pdf?, :office_document?, :representative_id, :to_s, to: :solr_document
+
+    # Methods used by blacklight helpers
+    delegate :has?, :first, :fetch, to: :solr_document
+
+    # Metadata Methods
+    delegate :title, :label, :description, :creator, :contributor, :subject,
+             :publisher, :language, :date_uploaded, :rights,
+             :embargo_release_date, :lease_expiration_date,
+             :depositor, :keyword, :title_or_label, :depositor, :keyword,
+             :date_created, :date_modified, :itemtype,
+             to: :solr_document
+
+    def single_use_links
+      @single_use_links ||= SingleUseLink.where(itemId: id).map { |link| link_presenter_class.new(link) }
+    end
+
+    # The title of the webpage that shows this FileSet.
+    def page_title
+      first_title
+    end
+
+    # The first title assertion
+    def first_title
+      title.first
+    end
+
+    # The link text when linking to the show page of this FileSet
+    def link_name
+      current_ability.can?(:read, id) ? first_title : 'File'
+    end
+
+    def editor?
+      current_ability.can?(:edit, solr_document)
+    end
+
+    def tweeter
+      user = ::User.find_by_user_key(depositor)
+      if user.try(:twitter_handle).present?
+        "@#{user.twitter_handle}"
+      else
+        I18n.translate('hyrax.product_twitter_handle')
+      end
+    end
+
+    def rights
+      return if solr_document.rights.nil?
+      solr_document.rights.first
+    end
+
+    def stats_path
+      Hyrax::Engine.routes.url_helpers.stats_file_path(self)
+    end
+
+    def events(size = 100)
+      super(size)
+    end
+
+    # This overrides the method in WithEvents
+    def event_class
+      solr_document.to_model.model_name.name
+    end
+
+    def audit_status
+      audit_service.logged_audit_status
+    end
+
+    def parent
+      ids = ActiveFedora::SolrService.query("{!field f=member_ids_ssim}#{id}",
+                                            fl: ActiveFedora.id_field)
+                                     .map { |x| x.fetch(ActiveFedora.id_field) }
+      @parent_presenter ||= Hyrax::PresenterFactory.build_presenters(ids,
+                                                                     WorkShowPresenter,
+                                                                     current_ability).first
+    end
+
+    def audit_service
+      @audit_service ||= Hyrax::FileSetAuditService.new(id)
+    end
+
+    private
+
+      def link_presenter_class
+        SingleUseLinkPresenter
+      end
+  end
+end

data/app/presenters/hyrax/file_usage.rb

@@ -0,0 +1,37 @@
+# Called by the stats controller, it finds cached file pageview data,
+# and prepares it for visualization in /app/views/stats/file.html.erb
+module Hyrax
+  class FileUsage < StatsUsagePresenter
+    def initialize(id)
+      self.model = ::FileSet.find(id)
+    end
+
+    alias file model
+
+    def total_downloads
+      downloads.reduce(0) { |total, result| total + result[1].to_i }
+    end
+
+    def total_pageviews
+      pageviews.reduce(0) { |total, result| total + result[1].to_i }
+    end
+
+    # Package data for visualization using JQuery Flot
+    def to_flot
+      [
+        { label: "Pageviews",  data: pageviews },
+        { label: "Downloads",  data: downloads }
+      ]
+    end
+
+    private
+
+      def downloads
+        to_flots(FileDownloadStat.statistics(model, created, user_id))
+      end
+
+      def pageviews
+        to_flots(FileViewStat.statistics(model, created, user_id))
+      end
+  end
+end

data/app/presenters/hyrax/homepage_presenter.rb

@@ -0,0 +1,13 @@
+module Hyrax
+  class HomepagePresenter
+    attr_reader :current_ability
+
+    def initialize(current_ability)
+      @current_ability = current_ability
+    end
+
+    def display_share_button?
+      Hyrax.config.always_display_share_button || current_ability.can_create_any_work?
+    end
+  end
+end

data/app/presenters/hyrax/inspect_work_presenter.rb

@@ -0,0 +1,52 @@
+module Hyrax
+  class InspectWorkPresenter
+    def initialize(solr_document, current_ability)
+      @solr_document = solr_document
+      @current_ability = current_ability
+    end
+    attr_reader :solr_document, :current_ability
+
+    def workflow
+      return { comments: [], roles: [] } unless sipity_entity
+      {
+        entity_id: sipity_entity.id,
+        proxy_for: sipity_entity.proxy_for_global_id,
+        workflow_id: sipity_entity.workflow_id,
+        workflow_name: sipity_entity.workflow_name,
+        state_id: sipity_entity.workflow_state_id,
+        state_name: sipity_entity.workflow_state_name,
+        comments: workflow_comments,
+        roles: sipity_entity_roles
+      }
+    end
+
+    def solr
+      @solr_document.inspect
+    end
+
+    private
+
+      def sipity_entity
+        @sipity_entity ||= PowerConverter.convert(solr_document, to: :sipity_entity)
+      end
+
+      def sipity_entity_roles
+        roles = Workflow::PermissionQuery.scope_roles_associated_with_the_given_entity(entity: solr_document)
+        roles.map do |role|
+          { id: role.id, name: role.name, description: role.description, users: sipity_entity_role_users(role) }
+        end
+      end
+
+      def sipity_entity_role_users(role)
+        users = Workflow::PermissionQuery.scope_users_for_entity_and_roles(entity: sipity_entity, roles: role)
+        users.map(&:user_key)
+      end
+
+      def workflow_comments
+        return [] unless sipity_entity && sipity_entity.comments.count > 0
+        sipity_entity.comments.map do |comment|
+          { comment: comment.comment, created_at: comment.created_at }
+        end
+      end
+  end
+end