blacklight-spotlight 0.4.1 → 0.5.0

data/app/models/spotlight/feature_page.rb

@@ -1,14 +1,16 @@
 module Spotlight
+  ##
+  # Feature pages
   class FeaturePage < Spotlight::Page
     extend FriendlyId
-    friendly_id :title, use: [:slugged,:scoped,:finders,:history], scope: :exhibit
+    friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: :exhibit
 
-    has_many   :child_pages, class_name: "Spotlight::FeaturePage", inverse_of: :parent_page, foreign_key: "parent_page_id"
-    belongs_to :parent_page, class_name: "Spotlight::FeaturePage"
+    has_many :child_pages, class_name: 'Spotlight::FeaturePage', inverse_of: :parent_page, foreign_key: 'parent_page_id'
+    belongs_to :parent_page, class_name: 'Spotlight::FeaturePage'
 
     accepts_nested_attributes_for :child_pages
-    
-    belongs_to :thumbnail, class_name: "Spotlight::FeaturedImage", dependent: :destroy
+
+    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy
     accepts_nested_attributes_for :thumbnail, update_only: true
 
     before_validation unless: :top_level_page? do
@@ -16,11 +18,11 @@ module Spotlight
     end
 
     def display_sidebar?
-      child_pages.published.present? || self.display_sidebar
+      child_pages.published.present? || display_sidebar
     end
 
     def thumbnail_image_url
-      thumbnail.image.thumb.url if thumbnail and thumbnail.image
+      thumbnail.image.thumb.url if thumbnail && thumbnail.image
     end
   end
 end

data/app/models/spotlight/featured_image.rb

@@ -1,38 +1,38 @@
 module Spotlight
+  ##
+  # Featured images for browse categories, feature pages, and exhibits
   class FeaturedImage < ActiveRecord::Base
     mount_uploader :image, Spotlight::FeaturedImageUploader
 
     before_validation do
-      if self.document and self.document.uploaded_resource?
-        self.image = self.document.uploaded_resource.url.file
+      if document && document.uploaded_resource?
+        self.image = document.uploaded_resource.url.file
       end
     end
 
     after_save do
       if image.present?
-        image.cache! if !image.cached?
+        image.cache! unless image.cached?
         image.store!
         recreate_image_versions
       end
     end
 
-    def remote_image_url= url
-      # if the image is local, this step will fail.. 
+    def remote_image_url=(url)
+      # if the image is local, this step will fail..
       # hopefully it's local because it's an uploaded resource, and we'll
       # catch is in before_validation..
-      unless url.starts_with? "/"
-        super url
-      end
+      super url unless url.starts_with? '/'
     end
 
     def document
       return unless document_global_id && source == 'exhibit'
 
-      if @document and document_global_id != @document.to_global_id.to_s
+      if @document && document_global_id != @document.to_global_id.to_s
         @document = nil
       end
 
       @document ||= GlobalID::Locator.locate document_global_id
     end
   end
-end
+end

data/app/models/spotlight/field_metadata.rb

@@ -0,0 +1,46 @@
+module Spotlight
+  ##
+  # Expose Solr index metadata about fields
+  class FieldMetadata
+    attr_reader :repository, :blacklight_config
+    def initialize(repository, blacklight_config)
+      @repository = repository
+      @blacklight_config = blacklight_config
+    end
+
+    def field(field_name)
+      {
+        document_count: document_counts.fetch(field_name, 0),
+        value_count: fields.fetch(field_name, {}).fetch('distinct', 0),
+        terms: fields.fetch(field_name, {}).fetch('topTerms', [])
+      }
+    end
+
+    private
+
+    def luke
+      @luke ||= repository.send_and_receive('admin/luke', fl: '*', 'json.nl' => 'map')
+    end
+
+    def fields
+      luke['fields']
+    end
+
+    # This gets the number of *documents* with a field
+    def document_counts
+      @document_count ||= begin
+        solr_resp = repository.search('facet.query' => facet_fields.map { |_key, fields| "#{fields.field}:[* TO *]" },
+                                      'rows' => 0,
+                                      'facet' => true)
+
+        solr_resp['facet_counts']['facet_queries'].each_with_object({}) do |(k, v), h|
+          h[k.split(/:/).first] = v
+        end
+      end
+    end
+
+    def facet_fields
+      blacklight_config.facet_fields.reject { |_k, v| v.pivot || v.query }
+    end
+  end
+end

data/app/models/spotlight/home_page.rb

@@ -1,22 +1,25 @@
 module Spotlight
+  ##
+  # Exhibit home page
   class HomePage < Spotlight::Page
     extend FriendlyId
-    friendly_id :title, use: [:slugged,:scoped,:finders], scope: :exhibit
+    friendly_id :title, use: [:slugged, :scoped, :finders], scope: :exhibit
 
     before_save :publish
     before_create :default_content
 
     def should_display_title?
-      display_title
+      display_title?
     end
 
     def display_sidebar?
-      exhibit.searchable? && self.display_sidebar
+      display_sidebar
     end
 
     private
+
     def self.default_title_text
-      "Exhibit Home"
+      I18n.t('spotlight.pages.index.home_pages.title')
     end
 
     def publish
@@ -24,7 +27,7 @@ module Spotlight
     end
 
     def default_content
-      self.title = Spotlight::HomePage.default_title_text
+      self.title ||= Spotlight::HomePage.default_title_text
     end
   end
 end

data/app/models/spotlight/lock.rb

@@ -1,4 +1,6 @@
 module Spotlight
+  ##
+  # Page-level locking to discourage update conflicts
   class Lock < ActiveRecord::Base
     belongs_to :on, polymorphic: true
     belongs_to :by, polymorphic: true
@@ -12,8 +14,7 @@ module Spotlight
     end
 
     def stale?
-      created_at < (Time.now - 12.hours)
+      created_at < (Time.zone.now - 12.hours)
     end
-
   end
-end
+end

data/app/models/spotlight/main_navigation.rb

@@ -1,11 +1,17 @@
 module Spotlight
+  ##
+  # Exhibit navbar links
   class MainNavigation < ActiveRecord::Base
     belongs_to :exhibit, touch: true
-    default_scope  -> { order("weight ASC") }
-    scope :browse, -> { where(nav_type: "browse").take }
-    scope :about,  -> { where(nav_type: "about").take  }
+    default_scope { order('weight ASC') }
+    scope :browse, -> { find_by(nav_type: 'browse') }
+    scope :about, -> { find_by(nav_type: 'about') }
     scope :displayable, -> { where(display: true) }
 
+    def displayable?
+      display?
+    end
+
     def label_or_default
       if label.present?
         label

data/app/models/spotlight/masthead.rb

@@ -1,20 +1,21 @@
-class Spotlight::Masthead < Spotlight::FeaturedImage
-  mount_uploader :image, Spotlight::MastheadUploader
+module Spotlight
+  ##
+  # Exhibit and browse category mastheads
+  class Masthead < Spotlight::FeaturedImage
+    mount_uploader :image, Spotlight::MastheadUploader
 
-  def display?
-    self.display && image.cropped.present?
-  end
-  
-  # Duplicated from Spotlight::FeaturedImage, because mount_uploader
-  # will overwrite it..
-  #
-  # if the image is local, this step will fail.. 
-  # hopefully it's local because it's an uploaded resource, and we'll
-  # catch is in before_validation..
-  def remote_image_url= url
-    unless url.starts_with? "/"
-      super url
+    def display?
+      display && image.cropped.present?
     end
-  end
 
+    # Duplicated from Spotlight::FeaturedImage, because mount_uploader
+    # will overwrite it..
+    #
+    # if the image is local, this step will fail..
+    # hopefully it's local because it's an uploaded resource, and we'll
+    # catch is in before_validation..
+    def remote_image_url=(url)
+      super url unless url.starts_with? '/'
+    end
+  end
 end

data/app/models/spotlight/page.rb

@@ -1,19 +1,21 @@
 module Spotlight
+  ##
+  # Base page class. See {Spotlight::AboutPage}, {Spotlight::FeaturePage}, {Spotlight::HomePage}
   class Page < ActiveRecord::Base
     MAX_PAGES = 50
 
     extend FriendlyId
-    friendly_id :title, use: [:slugged,:scoped,:finders,:history], scope: :exhibit
+    friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: :exhibit
 
     belongs_to :exhibit, touch: true
-    belongs_to :created_by, class_name: "::User"
-    belongs_to :last_edited_by, class_name: "::User"
-    validates :weight, :inclusion => { :in => Proc.new{ 0..Spotlight::Page::MAX_PAGES } }
+    belongs_to :created_by, class_name: '::User'
+    belongs_to :last_edited_by, class_name: '::User'
+    validates :weight, inclusion: { in: proc { 0..Spotlight::Page::MAX_PAGES } }
 
-    default_scope { order("weight ASC") }
+    default_scope { order('weight ASC') }
     scope :at_top_level, -> { where(parent_page_id: nil) }
     scope :published, -> { where(published: true) }
-    scope :recent, -> { order("updated_at DESC").limit(10)}
+    scope :recent, -> { order('updated_at DESC').limit(10) }
 
     has_one :lock, as: :on, dependent: :destroy
     sir_trevor_content :content
@@ -29,7 +31,7 @@ module Spotlight
       @content = nil
     end
 
-    def content= content
+    def content=(content)
       if content.is_a? Array
         super content.to_json
       else
@@ -38,9 +40,10 @@ module Spotlight
       content_changed!
     end
 
-    def has_content?
-      read_attribute(:content).present? and content.present?
+    def content?
+      self[:content].present? && content.present?
     end
+    alias_method :has_content?, :content?
 
     def display_sidebar?
       true
@@ -50,10 +53,10 @@ module Spotlight
       nil
     end
 
-    # explicitly set the partial path so that 
+    # explicitly set the partial path so that
     # we don't have to duplicate view logic.
     def to_partial_path
-      "spotlight/pages/page"
+      'spotlight/pages/page'
     end
 
     def feature_page?
@@ -80,11 +83,8 @@ module Spotlight
       title.present?
     end
 
-    def lock! user
-      unless lock.present?
-        create_lock(by: user)
-        lock.current_session!
-      end
+    def lock!(user)
+      create_lock(by: user).tap(&:current_session!) unless lock.present?
     end
   end
 end

data/app/models/spotlight/resource.rb

@@ -1,4 +1,6 @@
 module Spotlight
+  ##
+  # Exhibit resources
   class Resource < ActiveRecord::Base
     include Spotlight::SolrDocument::AtomicUpdates
     extend ActiveModel::Callbacks
@@ -20,21 +22,23 @@ module Spotlight
       Spotlight::Engine.config.resource_providers
     end
 
-    def self.class_for_resource r
-      p = providers.select do |p|
-        p.can_provide? r
-      end
-
-      p.sort_by(&:weight).first
+    def self.class_for_resource(r)
+      providers.select { |provider| provider.can_provide? r }.sort_by(&:weight).first
     end
 
+    ##
+    # @abstract
+    # Convert this resource into zero-to-many new solr documents. The data here
+    # should be merged into the resource-specific {#to_solr} data.
+    #
+    # @return [Hash] a single solr document hash
+    # @return [Enumerator<Hash>] multiple solr document hashes. This can be a
+    #   simple array, or an lazy enumerator
     def to_solr
-      exhibit.solr_data.merge({
-        Spotlight::Resource.resource_global_id_field => self.to_global_id.to_s,
-        Spotlight::SolrDocument.resource_type_field => self.class.to_s.tableize
-      })
+      (exhibit_specific_solr_data || {})
+        .merge(spotlight_resource_metadata_for_solr || {})
     end
-    
+
     def self.resource_global_id_field
       :"#{Spotlight::Engine.config.solr_fields.prefix}spotlight_resource_id#{Spotlight::Engine.config.solr_fields.string_suffix}"
     end
@@ -44,26 +48,33 @@ module Spotlight
         yield
       end
     end
-    
+
+    ##
+    # Index the result of {#to_solr} into the index in batches of {#batch_size}
     def reindex
       run_callbacks :index do
         data = to_solr
-        data = [data] unless data.is_a? Array
-        blacklight_solr.update params: { commitWithin: 500 }, data: data.to_json, headers: { 'Content-Type' => 'application/json'} unless data.empty?
+        return if data.blank?
+
+        data &&= [data] if data.is_a? Hash
+
+        data.each_slice(batch_size) do |batch|
+          blacklight_solr.update params: { commitWithin: 500 },
+                                 data: batch.reject(&:blank?).map { |doc| doc.reverse_merge(existing_solr_doc_hash(doc[unique_key]) || {}) }.to_json,
+                                 headers: { 'Content-Type' => 'application/json' }
+        end
       end
     end
 
     def update_index_time!
-      self.update_columns indexed_at: Time.current
+      update_columns indexed_at: Time.current
     end
 
     def becomes_provider
       klass = Spotlight::Resource.class_for_resource(self)
 
       if klass
-        z = self.becomes klass
-        z.type = z.class.to_s
-        z
+        self.becomes! klass
       else
         self
       end
@@ -74,21 +85,57 @@ module Spotlight
     end
 
     def save_and_commit
-      save.tap { blacklight_solr.commit rescue nil }
+      save.tap do
+        begin
+          blacklight_solr.commit
+        rescue => e
+          Rails.logger.warn "Unable to commit to solr: #{e}"
+        end
+      end
     end
 
     protected
 
     def blacklight_solr
-      @solr ||=  RSolr.connect(connection_config)
+      @solr ||= RSolr.connect(connection_config)
     end
 
     def connection_config
       Blacklight.connection_config
     end
-    
+
     def document_model
-      exhibit.blacklight_config.document_model
+      exhibit.blacklight_config.document_model if exhibit
+    end
+
+    def batch_size
+      Spotlight::Engine.config.solr_batch_size
+    end
+
+    def exhibit_specific_solr_data
+      exhibit.solr_data if exhibit
+    end
+
+    def spotlight_resource_metadata_for_solr
+      {
+        Spotlight::Resource.resource_global_id_field => (to_global_id.to_s if persisted?),
+        Spotlight::SolrDocument.resource_type_field => self.class.to_s.tableize
+      }
+    end
+
+    ##
+    # Get any exhibit-specific metadata stored in e.g. sidecars, tags, etc
+    # This needs the generated solr document
+    def existing_solr_doc_hash(id)
+      document_model.new(unique_key => id).to_solr if document_model && id.present?
+    end
+
+    def unique_key
+      if document_model
+        document_model.unique_key.to_sym
+      else
+        :id
+      end
     end
   end
 end