Module: BlacklightOaiProvider

Defined in:
app/controllers/concerns/blacklight_oai_provider/controller.rb,
lib/blacklight_oai_provider.rb,
lib/blacklight_oai_provider/set.rb,
lib/blacklight_oai_provider/engine.rb,
lib/blacklight_oai_provider/routes.rb,
lib/blacklight_oai_provider/version.rb,
lib/blacklight_oai_provider/solr_set.rb,
lib/blacklight_oai_provider/exceptions.rb,
lib/blacklight_oai_provider/resumption_token.rb,
lib/blacklight_oai_provider/response/list_sets.rb,
lib/blacklight_oai_provider/solr_document_wrapper.rb,
lib/blacklight_oai_provider/solr_document_provider.rb,
lib/generators/blacklight_oai_provider/install_generator.rb,
app/models/concerns/blacklight_oai_provider/solr_document.rb

Overview

Meant to be applied on top of a controller that implements Blacklight::SolrHelper. Will inject range limiting behaviors to solr parameters creation.

Defined Under Namespace

Modules: Controller, Exceptions, Response, Routes, SolrDocument Classes: Engine, InstallGenerator, ResumptionToken, Set, SolrDocumentProvider, SolrDocumentWrapper, SolrSet

Constant Summary collapse

VERSION = 
version

Class Method Summary collapse

Class Method Details

.inject! ⇒ Object 



25
26
27
 
# File 'lib/blacklight_oai_provider.rb', line 25

def self.inject!
  Blacklight::Routes.send(:include, BlacklightOaiProvider::Routes) unless BlacklightOaiProvider.omit_inject[:routes]
end

.omit_inject ⇒ Object 



21
22
23
 
# File 'lib/blacklight_oai_provider.rb', line 21

def self.omit_inject
  @omit_inject
end

.omit_inject=(value) ⇒ Object 



16
17
18
19
 
# File 'lib/blacklight_oai_provider.rb', line 16

def self.omit_inject=(value)
  value = Hash.new(true) if value == true
  @omit_inject = value
end

.root ⇒ Object

returns the full path the the blacklight plugin installation



35
36
37
 
# File 'lib/blacklight_oai_provider.rb', line 35

def self.root
  @root ||= File.expand_path(File.dirname(File.dirname(__FILE__)))
end

.safe_arr_add(array, element) ⇒ Object

Add element to array only if it’s not already there



30
31
32
 
# File 'lib/blacklight_oai_provider.rb', line 30

def self.safe_arr_add(array, element)
  array << element unless array.include?(element)
end

.version ⇒ Object 



3
4
5
 
# File 'lib/blacklight_oai_provider/version.rb', line 3

def self.version
  @version ||= File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).chomp
end