Module: Spotlight

Defined in:

lib/spotlight.rb,
lib/spotlight/engine.rb,
lib/spotlight/version.rb,
app/models/spotlight/lock.rb,
app/models/spotlight/page.rb,
app/models/spotlight/role.rb,
app/models/spotlight/site.rb,
app/models/spotlight/event.rb,
app/models/spotlight/group.rb,
app/services/spotlight/etl.rb,
lib/spotlight/search_state.rb,
app/models/spotlight/filter.rb,
app/models/spotlight/search.rb,
lib/spotlight/riiif_service.rb,
app/models/spotlight/ability.rb,
app/models/spotlight/contact.rb,
app/models/spotlight/exhibit.rb,
app/models/spotlight/language.rb,
app/models/spotlight/masthead.rb,
app/models/spotlight/resource.rb,
app/jobs/spotlight/reindex_job.rb,
app/models/spotlight/home_page.rb,
app/jobs/spotlight/add_tags_job.rb,
app/models/spotlight/about_page.rb,
app/models/spotlight/attachment.rb,
app/services/spotlight/etl/step.rb,
app/models/spotlight/bulk_update.rb,
app/models/spotlight/job_tracker.rb,
app/helpers/spotlight/crop_helper.rb,
app/helpers/spotlight/meta_helper.rb,
app/models/spotlight/analytics/ga.rb,
app/models/spotlight/contact_form.rb,
app/models/spotlight/custom_field.rb,
app/models/spotlight/feature_page.rb,
app/models/spotlight/group_member.rb,
app/models/spotlight/page_content.rb,
lib/spotlight/upload_field_config.rb,
app/helpers/spotlight/pages_helper.rb,
app/helpers/spotlight/roles_helper.rb,
app/helpers/spotlight/title_helper.rb,
app/jobs/spotlight/application_job.rb,
app/jobs/spotlight/remove_tags_job.rb,
app/jobs/spotlight/rename_tags_job.rb,
app/models/concerns/spotlight/user.rb,
app/models/spotlight/contact_email.rb,
app/models/spotlight/contact_image.rb,
app/services/spotlight/etl/context.rb,
app/services/spotlight/etl/loaders.rb,
app/services/spotlight/etl/sources.rb,
app/helpers/spotlight/browse_helper.rb,
app/helpers/spotlight/navbar_helper.rb,
app/models/spotlight/featured_image.rb,
app/models/spotlight/field_metadata.rb,
app/services/spotlight/etl/executor.rb,
app/services/spotlight/etl/pipeline.rb,
app/mailers/spotlight/contact_mailer.rb,
app/models/spotlight/main_navigation.rb,
app/models/spotlight/temporary_image.rb,
app/helpers/spotlight/masthead_helper.rb,
app/helpers/spotlight/searches_helper.rb,
app/models/concerns/spotlight/sitemap.rb,
app/models/spotlight/resources/upload.rb,
app/services/spotlight/etl/transforms.rb,
app/helpers/spotlight/languages_helper.rb,
app/helpers/spotlight/main_app_helpers.rb,
app/helpers/spotlight/rendering_helper.rb,
app/jobs/spotlight/reindex_exhibit_job.rb,
app/models/spotlight/exhibit_thumbnail.rb,
app/services/spotlight/etl/solr_loader.rb,
app/components/spotlight/icon_component.rb,
app/controllers/concerns/spotlight/base.rb,
app/helpers/spotlight/crud_link_helpers.rb,
app/jobs/spotlight/add_uploads_from_csv.rb,
app/mailers/spotlight/invitation_mailer.rb,
app/services/spotlight/validity_checker.rb,
app/helpers/spotlight/application_helper.rb,
app/jobs/concerns/spotlight/job_tracking.rb,
app/jobs/spotlight/change_visibility_job.rb,
app/jobs/spotlight/default_thumbnail_job.rb,
app/models/spotlight/custom_search_field.rb,
app/models/spotlight/page_configurations.rb,
app/components/spotlight/header_component.rb,
app/controllers/concerns/spotlight/config.rb,
app/controllers/spotlight/lock_controller.rb,
app/controllers/spotlight/solr_controller.rb,
app/controllers/spotlight/tags_controller.rb,
app/helpers/spotlight/job_trackers_helper.rb,
app/helpers/spotlight/translations_helper.rb,
app/mailers/spotlight/confirmation_mailer.rb,
app/models/spotlight/resources/csv_upload.rb,
app/controllers/concerns/spotlight/catalog.rb,
app/controllers/spotlight/pages_controller.rb,
app/controllers/spotlight/roles_controller.rb,
app/controllers/spotlight/sites_controller.rb,
app/jobs/spotlight/update_job_trackers_job.rb,
app/models/spotlight/resources/json_upload.rb,
app/models/spotlight/solr_document_sidecar.rb,
lib/generators/spotlight/install_generator.rb,
app/components/spotlight/document_component.rb,
app/controllers/spotlight/browse_controller.rb,
app/controllers/spotlight/groups_controller.rb,
app/jobs/spotlight/cleanup_job_trackers_job.rb,
app/jobs/spotlight/rename_sidecar_field_job.rb,
app/models/concerns/spotlight/resources/web.rb,
app/models/concerns/spotlight/solr_document.rb,
app/models/concerns/spotlight/translatables.rb,
app/models/spotlight/resources/iiif_service.rb,
app/services/spotlight/invite_users_service.rb,
app/uploaders/spotlight/attachment_uploader.rb,
app/controllers/spotlight/catalog_controller.rb,
app/controllers/spotlight/filters_controller.rb,
app/jobs/concerns/spotlight/gather_documents.rb,
app/models/concerns/spotlight/search_builder.rb,
app/models/spotlight/background_job_progress.rb,
app/models/spotlight/page_content/sir_trevor.rb,
app/models/spotlight/resources/iiif_manifest.rb,
app/controllers/concerns/spotlight/controller.rb,
app/controllers/spotlight/contacts_controller.rb,
app/controllers/spotlight/exhibits_controller.rb,
app/controllers/spotlight/searches_controller.rb,
app/controllers/spotlight/versions_controller.rb,
app/jobs/concerns/spotlight/limit_concurrency.rb,
app/models/spotlight/blacklight_configuration.rb,
app/models/spotlight/resources/iiif_harvester.rb,
app/services/spotlight/iiif_resource_resolver.rb,
app/uploaders/spotlight/bulk_updates_uploader.rb,
app/components/spotlight/breadcrumbs_component.rb,
app/controllers/spotlight/languages_controller.rb,
app/controllers/spotlight/resources_controller.rb,
app/mailers/spotlight/indexing_complete_mailer.rb,
app/models/concerns/spotlight/exhibit_defaults.rb,
app/controllers/spotlight/dashboards_controller.rb,
app/controllers/spotlight/home_pages_controller.rb,
app/jobs/spotlight/process_bulk_updates_csv_job.rb,
app/models/concerns/spotlight/exhibit_analytics.rb,
app/models/concerns/spotlight/exhibit_documents.rb,
app/uploaders/spotlight/featured_image_uploader.rb,
app/components/spotlight/tag_list_form_component.rb,
app/controllers/concerns/spotlight/search_helper.rb,
app/controllers/spotlight/about_pages_controller.rb,
app/controllers/spotlight/admin_users_controller.rb,
app/controllers/spotlight/appearances_controller.rb,
app/controllers/spotlight/application_controller.rb,
app/controllers/spotlight/attachments_controller.rb,
app/presenters/spotlight/iiif_manifest_presenter.rb,
app/services/spotlight/carrierwave_file_resolver.rb,
app/components/spotlight/exhibit_navbar_component.rb,
app/controllers/spotlight/bulk_actions_controller.rb,
app/controllers/spotlight/bulk_updates_controller.rb,
app/controllers/spotlight/job_trackers_controller.rb,
app/controllers/spotlight/translations_controller.rb,
app/controllers/spotlight/confirmations_controller.rb,
app/controllers/spotlight/contact_email_controller.rb,
app/controllers/spotlight/contact_forms_controller.rb,
app/controllers/spotlight/custom_fields_controller.rb,
app/controllers/spotlight/feature_pages_controller.rb,
app/helpers/spotlight/search_configurations_helper.rb,
app/models/concerns/spotlight/solr_document/finder.rb,
app/controllers/spotlight/featured_images_controller.rb,
app/services/spotlight/exhibit_import_export_service.rb,
lib/generators/spotlight/scaffold_resource_generator.rb,
app/controllers/spotlight/resources/upload_controller.rb,
app/components/spotlight/analytics/dashboard_component.rb,
app/components/spotlight/document_admin_table_component.rb,
app/components/spotlight/analytics/aggregation_component.rb,
app/controllers/spotlight/view_configurations_controller.rb,
app/services/spotlight/bulk_updates_csv_template_service.rb,
app/services/spotlight/clone_translated_page_from_locale.rb,
app/controllers/spotlight/concerns/application_controller.rb,
app/controllers/spotlight/concerns/catalog_search_context.rb,
app/controllers/spotlight/custom_search_fields_controller.rb,
app/controllers/spotlight/resources/csv_upload_controller.rb,
app/controllers/spotlight/search_configurations_controller.rb,
app/models/concerns/spotlight/custom_translation_extension.rb,
app/models/concerns/spotlight/solr_document/atomic_updates.rb,
app/controllers/spotlight/metadata_configurations_controller.rb,
app/models/concerns/spotlight/browse_category_search_builder.rb,
app/components/spotlight/solr_document_legacy_embed_component.rb,
app/controllers/spotlight/resources/iiif_harvester_controller.rb,
app/models/concerns/spotlight/solr_document/uploaded_resource.rb,
app/models/concerns/spotlight/blacklight_configuration_defaults.rb,
app/models/concerns/spotlight/access_controls_enforcement_search_builder.rb

Overview

Render an document suitable for embedding on a feature page.

Defined Under Namespace

Modules: Ability, AccessControlsEnforcementSearchBuilder, Analytics, ApplicationHelper, Base, BlacklightConfigurationDefaults, BrowseCategorySearchBuilder, BrowseHelper, Catalog, Concerns, Config, Controller, CropHelper, CrudLinkHelpers, CustomTranslationExtension, Etl, ExhibitAnalytics, ExhibitDefaults, ExhibitDocuments, GatherDocuments, JobTrackersHelper, JobTracking, LanguagesHelper, LimitConcurrency, MainAppHelpers, MastheadHelper, MetaHelper, NavbarHelper, PageContent, PagesHelper, RenderingHelper, Resources, RiiifService, RolesHelper, SearchBuilder, SearchConfigurationsHelper, SearchHelper, SearchesHelper, SolrDocument, TitleHelper, Translatables, TranslationsHelper, User Classes: AboutPage, AboutPagesController, AddTagsJob, AddUploadsFromCsv, AdminUsersController, AppearancesController, ApplicationController, ApplicationJob, Attachment, AttachmentUploader, AttachmentsController, BackgroundJobProgress, BlacklightConfiguration, BreadcrumbsComponent, BrowseController, BulkActionsController, BulkUpdate, BulkUpdatesController, BulkUpdatesCsvTemplateService, BulkUpdatesUploader, CarrierwaveFileResolver, CatalogController, ChangeVisibilityJob, CleanupJobTrackersJob, CloneTranslatedPageFromLocale, ConfirmationMailer, ConfirmationsController, Contact, ContactEmail, ContactEmailController, ContactForm, ContactFormsController, ContactImage, ContactMailer, ContactsController, CustomField, CustomFieldsController, CustomSearchField, CustomSearchFieldsController, DashboardsController, DefaultThumbnailJob, DocumentAdminTableComponent, DocumentComponent, Engine, Event, Exhibit, ExhibitImportExportService, ExhibitNavbarComponent, ExhibitThumbnail, ExhibitsController, FeaturePage, FeaturePagesController, FeaturedImage, FeaturedImageUploader, FeaturedImagesController, FieldMetadata, Filter, FiltersController, Group, GroupMember, GroupsController, HeaderComponent, HomePage, HomePagesController, IconComponent, IiifManifestPresenter, IiifResourceResolver, IndexingCompleteMailer, Install, InvitationMailer, InviteUsersService, JobTracker, JobTrackersController, Language, LanguagesController, Lock, LockController, MainNavigation, Masthead, MetadataConfigurationsController, Page, PageConfigurations, PagesController, ProcessBulkUpdatesCsvJob, ReindexExhibitJob, ReindexJob, RemoveTagsJob, RenameSidecarFieldJob, RenameTagsJob, Resource, ResourcesController, Role, RolesController, ScaffoldResource, Search, SearchConfigurationsController, SearchState, SearchesController, Site, Sitemap, SitesController, SolrController, SolrDocumentLegacyEmbedComponent, SolrDocumentSidecar, TagListFormComponent, TagsController, TemporaryImage, TranslationsController, UpdateJobTrackersJob, UploadFieldConfig, ValidityChecker, VersionsController, ViewConfigurationsController

Constant Summary

VERSION =

'4.2.0'

Class Method Summary

• .deprecator ⇒ Object

Instance Method Summary

• #create_routes ⇒ Object
• #inject_configuration ⇒ Object

Class Method Details

.deprecator ⇒ Object

# File 'lib/spotlight.rb', line 9

def self.deprecator
  @deprecator ||= ActiveSupport::Deprecation.new('5.0', 'blacklight-spotlight')
end

Instance Method Details

#create_routes ⇒ Object

# File 'lib/generators/spotlight/scaffold_resource_generator.rb', line 56

def create_routes
  route <<~FILE
    resources :exhibits, only: [] do
      resources :#{file_name}_resources, only: [:create, :update] do
      end
    end
  FILE
end

#inject_configuration ⇒ Object

# File 'lib/generators/spotlight/scaffold_resource_generator.rb', line 50

def inject_configuration
  inject_into_file 'config/initializers/spotlight_initializer.rb' do
    "\n  Spotlight::Engine.config.external_resources_partials += ['#{file_name}_resources/form']\n"
  end
end