Class: Hyrax::WorkShowPresenter

Inherits:
Object
  • Object
show all
Includes:
ModelProxy, PresentsAttributes
Defined in:
app/presenters/hyrax/work_show_presenter.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from PresentsAttributes

#attribute_to_html, #display_microdata?, #microdata_type_to_html, #permission_badge, #permission_badge_class

Methods included from ModelProxy

#persisted?, #to_model

Constructor Details

#initialize(solr_document, current_ability, request = nil) ⇒ WorkShowPresenter

Returns a new instance of WorkShowPresenter.

Parameters:

  • solr_document (SolrDocument)
  • current_ability (Ability)
  • request (ActionDispatch::Request) (defaults to: nil)

    the http request context. Used so the GraphExporter knows what URLs to draw.


29
30
31
32
33
# File 'app/presenters/hyrax/work_show_presenter.rb', line 29

def initialize(solr_document, current_ability, request = nil)
  @solr_document = Hyrax::SolrDocument::OrderedMembers.decorate(solr_document)
  @current_ability = current_ability
  @request = request
end

Instance Attribute Details

#current_abilityObject

Returns the value of attribute current_ability.


11
12
13
# File 'app/presenters/hyrax/work_show_presenter.rb', line 11

def current_ability
  @current_ability
end

#member_presenter_factory=(value) ⇒ Object

Sets the attribute member_presenter_factory

Parameters:

  • value

    the value to set the attribute member_presenter_factory to.


10
11
12
# File 'app/presenters/hyrax/work_show_presenter.rb', line 10

def member_presenter_factory=(value)
  @member_presenter_factory = value
end

#requestObject

Returns the value of attribute request.


11
12
13
# File 'app/presenters/hyrax/work_show_presenter.rb', line 11

def request
  @request
end

#solr_documentObject

Returns the value of attribute solr_document.


11
12
13
# File 'app/presenters/hyrax/work_show_presenter.rb', line 11

def solr_document
  @solr_document
end

Instance Method Details

#date_modifiedObject


111
112
113
# File 'app/presenters/hyrax/work_show_presenter.rb', line 111

def date_modified
  solr_document.date_modified.try(:to_formatted_s, :standard)
end

#date_uploadedObject


115
116
117
# File 'app/presenters/hyrax/work_show_presenter.rb', line 115

def date_uploaded
  solr_document.date_uploaded.try(:to_formatted_s, :standard)
end

#display_feature_link?Boolean

Returns:

  • (Boolean)

166
167
168
# File 'app/presenters/hyrax/work_show_presenter.rb', line 166

def display_feature_link?
  work_featurable? && FeaturedWork.can_create_another? && !featured?
end

#display_unfeature_link?Boolean

Returns:

  • (Boolean)

170
171
172
# File 'app/presenters/hyrax/work_show_presenter.rb', line 170

def display_unfeature_link?
  work_featurable? && featured?
end

#download_urlString

Returns a download URL, if work has representative media, or a blank string.

Returns:

  • (String)

    a download URL, if work has representative media, or a blank string


58
59
60
61
# File 'app/presenters/hyrax/work_show_presenter.rb', line 58

def download_url
  return '' if representative_presenter.nil?
  Hyrax::Engine.routes.url_helpers.download_url(representative_presenter, host: request.host)
end

#editor?Boolean

Deprecated.

use `::Ability.can?(:edit, presenter)`. Hyrax views calling presenter #editor methods will continue to call them until Hyrax 4.0.0. The deprecation time horizon for the presenter methods themselves is 5.0.0.

Returns:

  • (Boolean)

140
141
142
# File 'app/presenters/hyrax/work_show_presenter.rb', line 140

def editor?
  current_ability.can?(:edit, self)
end

#export_as_jsonldObject


127
128
129
# File 'app/presenters/hyrax/work_show_presenter.rb', line 127

def export_as_jsonld
  graph.dump(:jsonld, standard_prefixes: true)
end

#export_as_ntObject


123
124
125
# File 'app/presenters/hyrax/work_show_presenter.rb', line 123

def export_as_nt
  graph.dump(:ntriples)
end

#export_as_ttlObject


131
132
133
# File 'app/presenters/hyrax/work_show_presenter.rb', line 131

def export_as_ttl
  graph.dump(:ttl)
end

#grouped_presenters(filtered_by: nil, except: nil) ⇒ Array

Returns presenters grouped by model name, used to show the parents of this object.

Returns:

  • (Array)

    presenters grouped by model name, used to show the parents of this object


153
154
155
156
157
158
159
160
# File 'app/presenters/hyrax/work_show_presenter.rb', line 153

def grouped_presenters(filtered_by: nil, except: nil)
  # TODO: we probably need to retain collection_presenters (as parent_presenters)
  #       and join this with member_of_collection_presenters
  grouped = member_of_collection_presenters.group_by(&:model_name).transform_keys { |key| key.to_s.underscore }
  grouped.select! { |obj| obj.downcase == filtered_by } unless filtered_by.nil?
  grouped.except!(*except) unless except.nil?
  grouped
end

#iiif_viewerSymbol

Returns the name of the IIIF viewer partial to render.

Examples:

A work presenter with a custom iiif viewer

module Hyrax
  class GenericWorkPresenter < Hyrax::WorkShowPresenter
    def iiif_viewer
      :my_iiif_viewer
    end
  end
end

Custom iiif viewer partial at app/views/hyrax/base/iiif_viewers/_my_iiif_viewer.html.erb
<h3>My IIIF Viewer!</h3>
<a href=<%= main_app.polymorphic_url([main_app, :manifest, presenter], { locale: nil }) %>>Manifest</a>

Returns:

  • (Symbol)

    the name of the IIIF viewer partial to render


88
89
90
# File 'app/presenters/hyrax/work_show_presenter.rb', line 88

def iiif_viewer
  :universal_viewer
end

#iiif_viewer?Boolean Also known as: universal_viewer?

Returns render a IIIF viewer.

Returns:

  • (Boolean)

    render a IIIF viewer


64
65
66
67
68
69
70
# File 'app/presenters/hyrax/work_show_presenter.rb', line 64

def iiif_viewer?
  representative_id.present? &&
    representative_presenter.present? &&
    representative_presenter.image? &&
    Hyrax.config.iiif_image_server? &&
    members_include_viewable_image?
end

#inspect_workObject


53
54
55
# File 'app/presenters/hyrax/work_show_presenter.rb', line 53

def inspect_work
  @inspect_workflow ||= InspectWorkPresenter.new(solr_document, current_ability)
end

119
120
121
# File 'app/presenters/hyrax/work_show_presenter.rb', line 119

def link_name
  current_ability.can?(:read, id) ? to_s : 'Private'
end

#list_of_item_ids_to_displayArray

Returns list to display with Kaminari pagination.

Returns:

  • (Array)

    list to display with Kaminari pagination


185
186
187
# File 'app/presenters/hyrax/work_show_presenter.rb', line 185

def list_of_item_ids_to_display
  paginated_item_list(page_array: authorized_item_ids)
end

#manifest_metadataArray

IIIF metadata for inclusion in the manifest

Called by the `iiif_manifest` gem to add metadata

Returns:

  • (Array)

    array of metadata hashes


222
223
224
225
226
227
228
229
# File 'app/presenters/hyrax/work_show_presenter.rb', line 222

def 
  Hyrax.config..each_with_object([]) do |field, |
     << {
      'label' => I18n.t("simple_form.labels.defaults.#{field}"),
      'value' => Array.wrap(send(field).map { |f| Loofah.fragment(f.to_s).scrub!(:whitewash).to_s })
    }
  end
end

#manifest_urlObject


204
205
206
# File 'app/presenters/hyrax/work_show_presenter.rb', line 204

def manifest_url
  manifest_helper.polymorphic_url([:manifest, self])
end

#member_countInteger

Returns:

  • (Integer)

233
234
235
# File 'app/presenters/hyrax/work_show_presenter.rb', line 233

def member_count
  @member_count ||= member_presenters.count
end

#member_of_collection_presentersArray<CollectionPresenter>

Get presenters for the collections this work is a member of via the member_of_collections association.

Returns:


105
106
107
108
109
# File 'app/presenters/hyrax/work_show_presenter.rb', line 105

def member_of_collection_presenters
  PresenterFactory.build_for(ids: member_of_authorized_parent_collections,
                             presenter_class: collection_presenter_class,
                             presenter_args: presenter_factory_arguments)
end

#member_presenters_for(an_array_of_ids) ⇒ Array<presenter_class>

Deprecated.

use `#member_presenters(ids)` instead

Returns presenters for the array of ids (not filtered by class).

Parameters:

  • ids (Array<String>)

    a list of ids to build presenters for

Returns:

  • (Array<presenter_class>)

    presenters for the array of ids (not filtered by class)


194
195
196
197
# File 'app/presenters/hyrax/work_show_presenter.rb', line 194

def member_presenters_for(an_array_of_ids)
  Deprecation.warn("Use `#member_presenters` instead.")
  member_presenters(an_array_of_ids)
end

#modelObject


178
179
180
# File 'app/presenters/hyrax/work_show_presenter.rb', line 178

def model
  solr_document.to_model
end

#page_titleObject


35
36
37
# File 'app/presenters/hyrax/work_show_presenter.rb', line 35

def page_title
  "#{human_readable_type} | #{title.first} | ID: #{id} | #{I18n.t('hyrax.product_name')}"
end

#presenter_typesObject


148
149
150
# File 'app/presenters/hyrax/work_show_presenter.rb', line 148

def presenter_types
  Hyrax.config.registered_curation_concern_types.map(&:underscore) + ["collection"]
end

#representative_presenterObject

Returns FileSetPresenter presenter for the representative FileSets.

Returns:

  • FileSetPresenter presenter for the representative FileSets


93
94
95
96
97
98
99
100
101
# File 'app/presenters/hyrax/work_show_presenter.rb', line 93

def representative_presenter
  return nil if representative_id.blank?
  @representative_presenter ||=
    begin
      result = member_presenters([representative_id]).first
      return nil if result.try(:id) == id
      result.try(:representative_presenter) || result
    end
end

#sequence_renderingArray

IIIF rendering linking property for inclusion in the manifest

Called by the `iiif_manifest` gem to add a 'rendering' (eg. a link a download for the resource)

Returns:

  • (Array)

    array of rendering hashes


212
213
214
215
216
# File 'app/presenters/hyrax/work_show_presenter.rb', line 212

def sequence_rendering
  solr_document.rendering_ids.each_with_object([]) do |file_set_id, renderings|
    renderings << manifest_helper.build_rendering(file_set_id)
  end.flatten
end

#show_deposit_for?(collections:) ⇒ Boolean

Given a set of collections, which the caller asserts the current ability can deposit to, decide whether to display actions to add this work to a collection.

By default, this returns `true` if any collections are passed in OR the current ability can create a collection.

Parameters:

  • collections (Enumerable<::Collection>, nil)

    list of collections to which the current ability can deposit

Returns:

  • (Boolean)

    a flag indicating whether to display collection deposit options.


250
251
252
# File 'app/presenters/hyrax/work_show_presenter.rb', line 250

def show_deposit_for?(collections:)
  collections.present? || current_ability.can?(:create_any, ::Collection)
end

#stats_pathObject


174
175
176
# File 'app/presenters/hyrax/work_show_presenter.rb', line 174

def stats_path
  Hyrax::Engine.routes.url_helpers.stats_work_path(self, locale: I18n.locale)
end

#total_pagesInteger

Returns total number of pages of viewable items.

Returns:

  • (Integer)

    total number of pages of viewable items


200
201
202
# File 'app/presenters/hyrax/work_show_presenter.rb', line 200

def total_pages
  (total_items.to_f / rows_from_params.to_f).ceil
end

#tweeterObject


144
145
146
# File 'app/presenters/hyrax/work_show_presenter.rb', line 144

def tweeter
  TwitterPresenter.twitter_handle_for(user_key: depositor)
end

#valid_child_concernsArray<Class>

Returns:

  • (Array<Class>)

256
257
258
# File 'app/presenters/hyrax/work_show_presenter.rb', line 256

def valid_child_concerns
  Hyrax::ChildTypes.for(parent: solr_document.hydra_model).to_a
end

#work_featurable?Boolean

Returns:

  • (Boolean)

162
163
164
# File 'app/presenters/hyrax/work_show_presenter.rb', line 162

def work_featurable?
  user_can_feature_works? && solr_document.public?
end

#workflowObject


49
50
51
# File 'app/presenters/hyrax/work_show_presenter.rb', line 49

def workflow
  @workflow ||= WorkflowPresenter.new(solr_document, current_ability)
end