Class: SirTrevorRails::Blocks::SolrDocumentsBlock

Inherits:
SirTrevorRails::Block show all
Includes:
Displayable, Textable
Defined in:
app/models/sir_trevor_rails/blocks/solr_documents_block.rb

Overview

Multi-up document viewer with text block

Constant Summary

Constants inherited from SirTrevorRails::Block

SirTrevorRails::Block::DEFAULT_FORMAT

Instance Attribute Summary collapse

Attributes inherited from SirTrevorRails::Block

#parent, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Displayable

#item_ids, #items, #ordered_items

Methods included from Textable

#content_align, #text, #text?, #text_align

Methods inherited from SirTrevorRails::Block

#as_json, block_class, block_class!, custom_block_type_alt_text_settings, custom_block_types, #format, from_hash, #initialize, #to_partial_path, type_klass

Constructor Details

This class inherits a constructor from SirTrevorRails::Block

Instance Attribute Details

#solr_helper ⇒ Object (readonly)

Returns the value of attribute solr_helper.



11
12
13
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 11

def solr_helper
  @solr_helper
end

Class Method Details

.supports_alt_text? ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 17

def self.supports_alt_text?
  true
end

Instance Method Details

#document_caption(presenter, caption_field, default: nil) ⇒ Object 



56
57
58
59
60
61
62
63
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 56

def document_caption(presenter, caption_field, default: nil)
  caption_field ||= default

  return unless caption_field
  return presenter.heading if caption_field == Spotlight::PageConfigurations::DOCUMENT_TITLE_KEY

  presenter.field_value(solr_helper.blacklight_config.index_fields[caption_field] || null_display_field_class.new(caption_field))
end

#documents ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 31

def documents
  @documents ||= begin
    doc_ids = items.pluck(:id)
    result = solr_helper.controller.send(:search_service).fetch(doc_ids)

    if result.first.is_a? Blacklight::Solr::Response
      result.last
    else
      result
    end
  end
end

#documents? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 44

def documents?
  each_document.any?
end

#each_document ⇒ Object 



21
22
23
24
25
26
27
28
29
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 21

def each_document
  return to_enum(:each_document) unless block_given?

  items.each do |i|
    document = documents.detect { |doc| doc.id == i[:id] }
    i[:iiif_tilesource_base] = i.fetch(:iiif_tilesource, '').sub('/info.json', '')
    yield i, document if document
  end
end

#null_display_field_class ⇒ Object 



87
88
89
90
91
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 87

def null_display_field_class
  return Blacklight::Configuration::NullDisplayField if defined?(Blacklight::Configuration::NullDisplayField)

  Blacklight::Configuration::NullField
end

#primary_caption? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 48

def primary_caption?
  primary_caption_field.present? && show_primary_caption?
end

#primary_caption_field ⇒ Object 



77
78
79
80
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 77

def primary_caption_field
  val = send(:'primary-caption-field')
  val.presence
end

#secondary_caption? ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 65

def secondary_caption?
  secondary_caption_field.present? && show_secondary_caption?
end

#secondary_caption_field ⇒ Object 



82
83
84
85
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 82

def secondary_caption_field
  val = send(:'secondary-caption-field')
  val.presence
end

#show_primary_caption? ⇒ Boolean

Returns:

  • (Boolean) 


52
53
54
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 52

def show_primary_caption?
  ActiveModel::Type::Boolean.new.cast(send(:'show-primary-caption'))
end

#show_secondary_caption? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 69

def show_secondary_caption?
  ActiveModel::Type::Boolean.new.cast(send(:'show-secondary-caption'))
end

#with_solr_helper(solr_helper) ⇒ Object 



13
14
15
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 13

def with_solr_helper(solr_helper)
  @solr_helper = solr_helper
end

#zpr_link? ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
 
# File 'app/models/sir_trevor_rails/blocks/solr_documents_block.rb', line 73

def zpr_link?
  zpr_link == 'true'
end