blacklight-spotlight 0.4.1 → 0.5.0

data/app/models/spotlight/resources/csv_upload.rb

@@ -1,7 +1,11 @@
 module Spotlight
-  class Resources::CsvUpload
-    attr_reader :url
-    include ActiveModel::Model
-    extend ActiveModel::Translation
+  module Resources
+    ##
+    # Shim object for CSV Uploads. see {Spotlight::AddUploadsFromCsv}
+    class CsvUpload
+      attr_reader :url
+      include ActiveModel::Model
+      extend ActiveModel::Translation
+    end
   end
 end

data/app/models/spotlight/resources/upload.rb

@@ -1,81 +1,92 @@
 # encoding: utf-8
 module Spotlight
-  class Resources::Upload < Spotlight::Resource
-    mount_uploader :url, Spotlight::ItemUploader
-    include Spotlight::ImageDerivatives
-    
-    # we want to do this before reindexing
-    after_create :update_document_sidecar
-
-    def self.fields(exhibit)
-      @fields ||= {}
-      @fields[exhibit] ||= [Spotlight::Engine.config.upload_title_field || OpenStruct.new(field_name: exhibit.blacklight_config.index.title_field)] + exhibit.uploaded_resource_fields
-    end
+  module Resources
+    ##
+    # Exhibit-specific resources, created using uploaded and custom fields
+    class Upload < Spotlight::Resource
+      mount_uploader :url, Spotlight::ItemUploader
+      include Spotlight::ImageDerivatives
+
+      # we want to do this before reindexing
+      after_create :update_document_sidecar
+
+      def self.fields(exhibit)
+        @fields ||= {}
+        @fields[exhibit] ||= begin
+          title_field = Spotlight::Engine.config.upload_title_field || OpenStruct.new(field_name: exhibit.blacklight_config.index.title_field)
+          [title_field] + exhibit.uploaded_resource_fields
+        end
+      end
 
-    def configured_fields
-      self.class.fields(exhibit)
-    end
+      def configured_fields
+        self.class.fields(exhibit)
+      end
 
-    def to_solr
-      store_url! # so that #url doesn't return the tmp directory
+      def to_solr
+        store_url! # so that #url doesn't return the tmp directory
 
-      solr_hash = super
-      
-      add_default_solr_fields solr_hash
+        solr_hash = super
 
-      add_image_dimensions solr_hash
+        add_default_solr_fields solr_hash
 
-      add_file_versions solr_hash
+        add_image_dimensions solr_hash
 
-      add_sidecar_fields solr_hash
+        add_file_versions solr_hash
 
-      solr_hash
-    end
+        add_sidecar_fields solr_hash
 
-    private
+        solr_hash
+      end
 
-    
-    def add_default_solr_fields solr_hash
-      solr_hash[exhibit.blacklight_config.document_model.unique_key.to_sym] = compound_id
-    end
+      private
 
-    def add_image_dimensions solr_hash
-      dimensions = ::MiniMagick::Image.open(url.file.file)[:dimensions]
-      solr_hash[:spotlight_full_image_width_ssm] = dimensions.first
-      solr_hash[:spotlight_full_image_height_ssm] = dimensions.last
-    end
+      def add_default_solr_fields(solr_hash)
+        solr_hash[exhibit.blacklight_config.document_model.unique_key.to_sym] = compound_id
+      end
 
-    def add_file_versions solr_hash
-      spotlight_image_derivatives.each do |config|
-        if config[:version]
-          solr_hash[config[:field]] = url.send(config[:version]).url
-        else
-          solr_hash[config[:field]] = url.url
+      def add_image_dimensions(solr_hash)
+        dimensions = ::MiniMagick::Image.open(url.file.file)[:dimensions]
+        solr_hash[:spotlight_full_image_width_ssm] = dimensions.first
+        solr_hash[:spotlight_full_image_height_ssm] = dimensions.last
+      end
+
+      def add_file_versions(solr_hash)
+        spotlight_image_derivatives.each do |config|
+          if config[:version]
+            solr_hash[config[:field]] = url.send(config[:version]).url
+          else
+            solr_hash[config[:field]] = url.url
+          end
         end
       end
-    end
 
-    def add_sidecar_fields solr_hash
-      solr_hash.merge! sidecar.to_solr
-    end
+      def add_sidecar_fields(solr_hash)
+        solr_hash.merge! sidecar.to_solr
+      end
 
-    def compound_id
-      "#{exhibit_id}-#{id}"
-    end
-    
-    def update_document_sidecar
-      sidecar_updates = data.slice(*exhibit.custom_fields.map(&:field).map(&:to_s)).select { |k,v| v.present? }
+      def compound_id
+        "#{exhibit_id}-#{id}"
+      end
+
+      def update_document_sidecar
+        sidecar.update(data: sidecar.data.merge(sidecar_update_data))
+      end
 
-      sidecar_updates["configured_fields"] = data.slice(*configured_fields.map(&:field_name).map(&:to_s)).select { |k,v| v.present? }
+      def sidecar_update_data
+        custom_fields_data.merge('configured_fields' => configured_fields_data)
+      end
 
-      sidecar.update(data: sidecar.data.merge(sidecar_updates))
+      def custom_fields_data
+        data.slice(*exhibit.custom_fields.map(&:field).map(&:to_s)).select { |_k, v| v.present? }
+      end
 
-      sidecar.save
-    end
+      def configured_fields_data
+        data.slice(*configured_fields.map(&:field_name).map(&:to_s)).select { |_k, v| v.present? }
+      end
 
-    def sidecar
-      @sidecar ||= document_model.new(id: compound_id).sidecar(exhibit)
+      def sidecar
+        @sidecar ||= document_model.new(id: compound_id).sidecar(exhibit)
+      end
     end
-
   end
 end

data/app/models/spotlight/role.rb

@@ -1,45 +1,41 @@
-class Spotlight::Role < ActiveRecord::Base
+module Spotlight
+  ##
+  # Exhibit authorization roles
+  class Role < ActiveRecord::Base
+    ROLES = %w(admin curator)
+    belongs_to :exhibit
+    belongs_to :user, class_name: '::User', autosave: true
+    validates :role, inclusion: { in: ROLES }
+    validates :user_key, presence: true
+    validate :user_must_exist, if: -> { user_key.present? }
+    validate :user_must_be_unique, if: :user
 
-  ROLES = %w(admin curator)
-  belongs_to :exhibit
-  belongs_to :user, class_name: '::User', autosave: true
-  validates :role, inclusion: { in: ROLES }
-  validates :user_key, presence: true
-  validate :user_must_exist, if: -> { user_key.present? }
-  validate :user_must_be_unique, if: :user
-
-  def user_key
-    if user
-       @user_key = user.user_key
-    else
-      @user_key
+    def user_key
+      if user
+        @user_key = user.user_key
+      else
+        @user_key
+      end
     end
-  end
 
-  # setting user key causes the user to get set
-  def user_key= key
-    @user_key = key
-    self.user ||= User.find_by_user_key(key)
-    if user
-      user.user_key = key
+    # setting user key causes the user to get set
+    def user_key=(key)
+      @user_key = key
+      self.user ||= ::User.find_by_user_key(key)
+      user.user_key = key if user
     end
-  end
 
-  protected
+    protected
 
-  def user_must_exist
-    unless user.present?
-      errors.add(:user_key, "User must sign up first.")
+    def user_must_exist
+      errors.add(:user_key, 'User must sign up first.') unless user.present?
     end
-  end
 
-  # This is just like 
-  #    validates :user, uniqueness: { scope: :exhibit}
-  # but it puts the error message on the user_key instead of user so that the form will render correctly
-  def user_must_be_unique
-    if Spotlight::Role.where(exhibit_id: exhibit_id, user_id: user.id).where.not(id: id).any? 
-      errors.add(:user_key, "already a member of this exhibit")
+    # This is just like
+    #    validates :user, uniqueness: { scope: :exhibit}
+    # but it puts the error message on the user_key instead of user so that the form will render correctly
+    def user_must_be_unique
+      errors.add(:user_key, 'already a member of this exhibit') if Spotlight::Role.where(exhibit_id: exhibit_id, user_id: user.id).where.not(id: id).any?
     end
   end
-
 end

data/app/models/spotlight/search.rb

@@ -1,82 +1,93 @@
-class Spotlight::Search < ActiveRecord::Base
+module Spotlight
+  ##
+  # Exhibit saved searches
+  class Search < ActiveRecord::Base
+    extend FriendlyId
+    friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: :exhibit
+
+    self.table_name = 'spotlight_searches'
+    belongs_to :exhibit
+    serialize :query_params, Hash
+    default_scope { order('weight ASC') }
+    scope :published, -> { where(published: true) }
+    validates :title, presence: true
+    has_paper_trail
+
+    belongs_to :masthead, dependent: :destroy
+    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy
+    accepts_nested_attributes_for :thumbnail, update_only: true
+    accepts_nested_attributes_for :masthead, update_only: true
+
+    before_create :set_default_featured_image
+
+    include Blacklight::SearchHelper
+    include Spotlight::Catalog::AccessControlsEnforcement
+
+    def thumbnail_image_url
+      thumbnail.image.thumb.url if thumbnail && thumbnail.image
+    end
 
-  extend FriendlyId
-  friendly_id :title, use: [:slugged,:scoped,:finders,:history], scope: :exhibit
+    def count
+      repository.search(search_builder.with(query_params).rows(0).merge(facet: false))['response']['numFound']
+    end
 
-  self.table_name = 'spotlight_searches'
-  belongs_to :exhibit
-  serialize :query_params, Hash
-  default_scope { order("weight ASC") }
-  scope :published, -> { where(on_landing_page: true) }
-  validates :title, presence: true
-  has_paper_trail
-  
-  belongs_to :masthead, dependent: :destroy
-  belongs_to :thumbnail, class_name: "Spotlight::FeaturedImage", dependent: :destroy
-  accepts_nested_attributes_for :thumbnail, update_only: true
-  accepts_nested_attributes_for :masthead, update_only: true
+    def images
+      documents.map do |doc|
+        [
+          doc.first(blacklight_config.document_model.unique_key),
+          doc.first(blacklight_config.index.title_field),
+          doc.first(blacklight_config.index.thumbnail_field)
+        ]
+      end
+    end
 
+    def documents
+      return enum_for(:documents) unless block_given?
 
-  before_create :set_default_featured_image
+      Blacklight::SolrResponse.new(solr_response, {}).docs.each do |result|
+        yield blacklight_config.document_model.new(result)
+      end
+    end
 
-  include Blacklight::SearchHelper
-  include Spotlight::Catalog::AccessControlsEnforcement
+    delegate :blacklight_config, to: :exhibit
 
-  def thumbnail_image_url
-    thumbnail.image.thumb.url if thumbnail and thumbnail.image
-  end
+    def display_masthead?
+      masthead && masthead.display?
+    end
 
-  def count
-    query_solr(query_params, rows: 0, facet: false)['response']['numFound']
-  end
+    private
 
-  def images
-    documents.map do |doc|
+    def solr_response
+      @solr_response ||= repository.search(
+        search_builder.with(query_params).rows(1000).merge(
+          facet: false,
+          fl: default_search_fields
+        )
+      )
+    end
 
+    def default_search_fields
       [
-        doc.first(blacklight_config.document_model.unique_key),
-        doc.first(blacklight_config.index.title_field),
-        doc.first(blacklight_config.index.thumbnail_field)
+        blacklight_config.document_model.unique_key,
+        blacklight_config.index.title_field,
+        blacklight_config.index.thumbnail_field,
+        Spotlight::Engine.config.full_image_field
       ]
     end
-  end
-
-  def documents
-    return enum_for(:documents) unless block_given?
 
-    Blacklight::SolrResponse.new(solr_response, {}).docs.each do |result|
-      yield blacklight_config.document_model.new(result)
+    def should_generate_new_friendly_id?
+      title_changed?
     end
-  end
-
-  def blacklight_config
-    exhibit.blacklight_config
-  end
 
-  def display_masthead?
-    masthead && masthead.display?
-  end
-
-  private
-  def solr_response
-    @solr_response ||= query_solr(query_params,
-      rows: 1000,
-      fl: [blacklight_config.document_model.unique_key, blacklight_config.index.title_field, blacklight_config.index.thumbnail_field, Spotlight::Engine.config.full_image_field],
-      facet: false)
-  end
-  def should_generate_new_friendly_id?
-    title_changed?
-  end
-
-  def set_default_featured_image
-    self.thumbnail ||= begin
-      if doc = documents.first
-        self.create_thumbnail source: 'exhibit', document_global_id: doc.to_global_id.to_s, remote_image_url: doc.first(Spotlight::Engine.config.full_image_field)
+    def set_default_featured_image
+      self.thumbnail ||= begin
+        doc = documents.detect { |x| x.first(Spotlight::Engine.config.full_image_field) }
+        if doc
+          create_thumbnail source: 'exhibit', document_global_id: doc.to_global_id.to_s, remote_image_url: doc.first(Spotlight::Engine.config.full_image_field)
+        end
       end
     end
-  end
-
-  
-  alias_method :current_exhibit, :exhibit
 
+    alias_method :current_exhibit, :exhibit
+  end
 end

data/app/models/spotlight/solr_document_sidecar.rb

@@ -1,10 +1,12 @@
 module Spotlight
+  ##
+  # Exhibit-specific metadata for indexed documents
   class SolrDocumentSidecar < ActiveRecord::Base
     belongs_to :exhibit
     belongs_to :document, polymorphic: true
     serialize :data, Hash
 
-    delegate :has_key?, to: :data
+    delegate :has_key?, :key?, to: :data
 
     def to_solr
       { document.class.unique_key.to_sym => document.id, visibility_field => public? }.merge(data_to_solr)
@@ -42,26 +44,26 @@ module Spotlight
     end
 
     def data_to_solr
-      data.except("configured_fields").merge(configured_fields_data_to_solr)
+      data.except('configured_fields').merge(configured_fields_data_to_solr)
     end
 
     def configured_fields_data_to_solr
-      solr_hash = {}
-      if data["configured_fields"]
-        configured_fields = Spotlight::Resources::Upload.fields(exhibit)
-
-        configured_fields.each do |field|
-          solr_fields = Array(field.solr_field || field.field_name)
-          if data["configured_fields"][field.field_name.to_s].present?
-            solr_fields.each do |solr_field|
-              solr_hash[solr_field] = data["configured_fields"][field.field_name.to_s]
-            end
-          end
+      configured_fields = data.fetch('configured_fields', {})
+
+      upload_fields.each_with_object({}) do |field, solr_hash|
+        field_name = field.field_name.to_s
+        next unless configured_fields && configured_fields[field_name].present?
+
+        solr_fields = Array(field.solr_field || field.field_name)
+
+        solr_fields.each do |solr_field|
+          solr_hash[solr_field] = configured_fields[field_name]
         end
       end
-
-      solr_hash.select { |k,v| v.present? }
     end
 
+    def upload_fields
+      Spotlight::Resources::Upload.fields(exhibit)
+    end
   end
 end