Module: GeoblacklightHelper

Defined in:
app/helpers/geoblacklight_helper.rb

Instance Method Summary collapse

Instance Method Details

#document_available? ⇒ Boolean

Returns:

  • (Boolean) 


4
5
6
 
# File 'app/helpers/geoblacklight_helper.rb', line 4

def document_available?
  @document.public? || (@document.same_institution? && user_signed_in?)
end

#document_downloadable? ⇒ Boolean

Returns:

  • (Boolean) 


8
9
10
 
# File 'app/helpers/geoblacklight_helper.rb', line 8

def document_downloadable?
  document_available? && @document.downloadable?
end

#download_link_file(label, id, url) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'app/helpers/geoblacklight_helper.rb', line 16

def download_link_file(label, id, url)
  link_to(
    label,
    url,
    "contentUrl" => url,
    :data => {
      download: "trigger",
      download_type: "direct",
      download_id: id
    }
  )
end

#download_link_generated(download_type, document) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'app/helpers/geoblacklight_helper.rb', line 55

def download_link_generated(download_type, document)
  link_to(
    t("geoblacklight.download.export_link", download_format: export_format_label(download_type)),
    "",
    data: {
      download_path: download_path(document.id, type: download_type),
      download: "trigger",
      download_type: download_type,
      download_id: document.id
    }
  )
end

#download_link_hgl(text, document) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'app/helpers/geoblacklight_helper.rb', line 29

def download_link_hgl(text, document)
  link_to(
    text,
    download_hgl_path(id: document),
    data: {
      blacklight_modal: "trigger",
      download: "trigger",
      download_type: "harvard-hgl",
      download_id: document.id
    }
  )
end

#download_link_iiif ⇒ String

Generates the link markup for the IIIF JPEG download

Returns:

  • (String) 


44
45
46
47
48
49
50
51
52
53
 
# File 'app/helpers/geoblacklight_helper.rb', line 44

def download_link_iiif
  link_to(
    download_text("JPG"),
    iiif_jpg_url,
    "contentUrl" => iiif_jpg_url,
    :data => {
      download: "trigger"
    }
  )
end

#download_text(format) ⇒ Object

Wraps download text with proper_case_format



114
115
116
117
118
 
# File 'app/helpers/geoblacklight_helper.rb', line 114

def download_text(format)
  download_format = proper_case_format(format)
  value = t("geoblacklight.download.download_link", download_format: download_format)
  value.html_safe
end

#export_format_label(format) ⇒ Object

Format labels are customized for exports - look up the appropriate key.



99
100
101
 
# File 'app/helpers/geoblacklight_helper.rb', line 99

def export_format_label(format)
  t("geoblacklight.download.export_#{format.to_s.parameterize(separator: "_")}_link")
end

#first_metadata?(document, metadata) ⇒ Boolean

Determines whether or not the metadata is the first within the array of References

Parameters:

Returns:

  • (Boolean) 


215
216
217
 
# File 'app/helpers/geoblacklight_helper.rb', line 215

def first_metadata?(document, metadata)
  document.references.shown_metadata.first.type == metadata.type
end

#formatted_name_reference(reference) ⇒ String

Looks up formatted names for references

Parameters:

  • reference (String, Symbol)

Returns:

  • (String) 


107
108
109
 
# File 'app/helpers/geoblacklight_helper.rb', line 107

def formatted_name_reference(reference)
  t "geoblacklight.references.#{reference}"
end

#geoblacklight_basemap ⇒ String

Selects the basemap used for map displays

Returns:

  • (String) 


171
172
173
 
# File 'app/helpers/geoblacklight_helper.rb', line 171

def geoblacklight_basemap
  blacklight_config.basemap_provider || "positron"
end

#geoblacklight_icon(name, **args) ⇒ SVG or HTML tag

Returns an SVG icon or empty HTML span element standard:disable Style/ArgumentsForwarding TODO: Remove linter disable after lowest supported Ruby version >= 3.2

Returns:

  • (SVG or HTML tag) 


81
82
83
84
85
86
87
88
 
# File 'app/helpers/geoblacklight_helper.rb', line 81

def geoblacklight_icon(name, **args)
  icon_name = name ? name.to_s.parameterize : "none"
  begin
    blacklight_icon(icon_name, **args)
  rescue Blacklight::Exceptions::IconNotFound
    tag.span class: "icon-missing geoblacklight-none"
  end
end

#iiif_jpg_url ⇒ Object 



12
13
14
 
# File 'app/helpers/geoblacklight_helper.rb', line 12

def iiif_jpg_url
  @document.references.iiif.endpoint.sub! "info.json", "full/full/0/default.jpg"
end

#iiif_manifest_container? ⇒ Boolean

Returns:

  • (Boolean) 


294
295
296
297
 
# File 'app/helpers/geoblacklight_helper.rb', line 294

def iiif_manifest_container?
  return false unless @document
  @document&.item_viewer&.viewer_preference&.key?(:iiif_manifest)
end

#iiif_manifest_viewer ⇒ Object 



299
300
301
 
# File 'app/helpers/geoblacklight_helper.rb', line 299

def iiif_manifest_viewer
  tag.div(nil, id: "clover-viewer", iiif_content: @document.viewer_endpoint)
end

#leaflet_options ⇒ Object

Returns a hash of the leaflet plugin settings to pass to the viewer. @return



191
192
193
 
# File 'app/helpers/geoblacklight_helper.rb', line 191

def leaflet_options
  Settings.LEAFLET
end

#leaflet_viewer ⇒ Object 



264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'app/helpers/geoblacklight_helper.rb', line 264

def leaflet_viewer
  tag.div(nil,
    id: "map",
    data: {
      :map => "item", :protocol => @document.viewer_protocol.camelize,
      :url => @document.viewer_endpoint,
      "layer-id" => @document.wxs_identifier,
      "map-geom" => @document.geometry.geojson,
      "catalog-path" => search_catalog_path,
      :available => document_available?,
      :basemap => geoblacklight_basemap,
      :leaflet_options => leaflet_options
    })
end

#ol_viewer ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'app/helpers/geoblacklight_helper.rb', line 279

def ol_viewer
  tag.div(nil,
    id: "ol-map",
    data: {
      :map => "item", :protocol => @document.viewer_protocol.camelize,
      :url => @document.viewer_endpoint,
      "layer-id" => @document.wxs_identifier,
      "map-geom" => @document.geometry.geojson,
      "catalog-path" => search_catalog_path,
      :available => document_available?,
      :basemap => geoblacklight_basemap,
      :leaflet_options => leaflet_options
    })
end

#openlayers_container? ⇒ Boolean

Returns:

  • (Boolean) 


259
260
261
262
 
# File 'app/helpers/geoblacklight_helper.rb', line 259

def openlayers_container?
  return false unless @document
  @document.item_viewer.pmtiles || @document.item_viewer.cog
end

#proper_case_format(format) ⇒ Object

Looks up properly formatted names for formats



94
95
96
 
# File 'app/helpers/geoblacklight_helper.rb', line 94

def proper_case_format(format)
  t("geoblacklight.formats.#{format.to_s.parameterize(separator: "_")}")
end

#relations_icon(document, icon) ⇒ Object

Returns the icon used based off a Settings strategy



231
232
233
234
235
236
237
 
# File 'app/helpers/geoblacklight_helper.rb', line 231

def relations_icon(document, icon)
  icon_name = document[Settings.FIELDS.GEOM_TYPE] if Settings.USE_GEOM_FOR_RELATIONS_ICON
  icon_name = icon if icon_name.blank?
  icon_options = {}
  icon_options = {classes: "svg_tooltip"} if Settings.USE_GEOM_FOR_RELATIONS_ICON
  geoblacklight_icon(icon_name, **icon_options)
end

#render_help_text_entry(feature, key) ⇒ HTML tag

Render help text popover for a given feature and translation key

Returns:

  • (HTML tag) 


130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'app/helpers/geoblacklight_helper.rb', line 130

def render_help_text_entry(feature, key)
  if I18n.exists?("geoblacklight.help_text.#{feature}.#{key}", locale)
    help_text = I18n.t("geoblacklight.help_text.#{feature}.#{key}")
    tag.h3 class: "help-text viewer_protocol h6" do
      tag.a data: {toggle: "popover", title: help_text[:title], content: help_text[:content]} do
        help_text[:title]
      end
    end
  else
    tag.span class: "help-text translation-missing"
  end
end

#render_references_url(args) ⇒ Object

Renders a reference url for a document

Parameters:

  • document, (Hash) —

    field_name



222
223
224
225
226
227
228
 
# File 'app/helpers/geoblacklight_helper.rb', line 222

def render_references_url(args)
  return unless args[:document]&.references&.url
  link_to(
    args[:document].references.url.endpoint,
    args[:document].references.url.endpoint
  )
end

#render_sidebar_map?(document) ⇒ Boolean

Determines if item view should render the sidebar static map

Returns:

  • (Boolean) 


146
147
148
 
# File 'app/helpers/geoblacklight_helper.rb', line 146

def render_sidebar_map?(document)
  Settings.SIDEBAR_STATIC_MAP&.any? { |vp| document.viewer_protocol == vp }
end

#render_transformed_metadata(metadata) ⇒ String

Renders the transformed metadata (Renders a partial when the metadata isn’t available)

Parameters:

Returns:

  • (String) 


200
201
202
203
204
205
206
207
208
 
# File 'app/helpers/geoblacklight_helper.rb', line 200

def render_transformed_metadata(metadata)
  render partial: "catalog/metadata/content", locals: {content: metadata.transform.html_safe}
rescue Geoblacklight::MetadataTransformer::TransformError => transform_err
  Geoblacklight.logger.warn transform_err.message
  render partial: "catalog/metadata/markup", locals: {content: metadata.to_xml}
rescue => err
  Geoblacklight.logger.warn err.message
  render partial: "catalog/metadata/missing"
end

#render_value_as_truncate_abstract(args) ⇒ Object

Render value for a document’s field as a truncate abstract div. Arguments come from Blacklight::DocumentPresenter’s get_field_values method

Parameters:

  • args (Hash) —

    from get_field_values



162
163
164
165
166
 
# File 'app/helpers/geoblacklight_helper.rb', line 162

def render_value_as_truncate_abstract(args)
  tag.div class: "truncate-abstract" do
    Array(args[:value]).flatten.join(" ")
  end
end

#render_web_services(reference) ⇒ Object

Renders the partials for a Geoblacklight::Reference in the web services modal

Parameters:



179
180
181
182
183
184
185
186
 
# File 'app/helpers/geoblacklight_helper.rb', line 179

def render_web_services(reference)
  render(
    partial: "web_services_#{reference.type}",
    locals: {reference: reference}
  )
rescue ActionView::MissingTemplate
  render partial: "web_services_default", locals: {reference: reference}
end

#results_js_map_selector(controller_name) ⇒ Object

Returns the data-map attribute value used as the JS map selector



240
241
242
243
244
245
246
247
 
# File 'app/helpers/geoblacklight_helper.rb', line 240

def results_js_map_selector(controller_name)
  case controller_name
  when "bookmarks"
    "bookmarks"
  else
    "index"
  end
end

#show_attribute_table? ⇒ Boolean

Deteremines if item view should include attribute table

Returns:

  • (Boolean) 


153
154
155
 
# File 'app/helpers/geoblacklight_helper.rb', line 153

def show_attribute_table?
  document_available? && @document.inspectable?
end

#show_help_text?(feature, key) ⇒ Boolean

Deteremines if a feature should include help text popover

Returns:

  • (Boolean) 


123
124
125
 
# File 'app/helpers/geoblacklight_helper.rb', line 123

def show_help_text?(feature, key)
  Settings&.HELP_TEXT&.send(feature)&.include?(key)
end

#snippit(args) ⇒ String

Blacklight catalog controller helper method to truncate field value to 150 chars

Parameters:

  • args (SolrDocument)

Returns:

  • (String) 


72
73
74
 
# File 'app/helpers/geoblacklight_helper.rb', line 72

def snippit(args)
  truncate(Array(args[:value]).flatten.join(" "), length: 150)
end

#viewer_container ⇒ Object 



249
250
251
252
253
254
255
256
257
 
# File 'app/helpers/geoblacklight_helper.rb', line 249

def viewer_container
  if openlayers_container?
    ol_viewer
  elsif iiif_manifest_container?
    iiif_manifest_viewer
  else
    leaflet_viewer
  end
end