blacklight-spotlight 0.4.1 → 0.5.0

data/app/models/concerns/spotlight/solr_document.rb

@@ -1,4 +1,6 @@
 module Spotlight
+  ##
+  # SolrDocument mixins to add ActiveModel shims and indexing methods
   module SolrDocument
     extend ActiveSupport::Concern
 
@@ -13,91 +15,96 @@ module Spotlight
 
       acts_as_taggable
       has_many :sidecars, class_name: 'Spotlight::SolrDocumentSidecar', as: :document
-      
+
       before_save :save_owned_tags
       after_save :reindex
 
-      use_extension(Spotlight::SolrDocument::UploadedResource) do |document|
-        document.uploaded_resource?
-      end
+      use_extension(Spotlight::SolrDocument::UploadedResource, &:uploaded_resource?)
     end
-    
-    module ClassMethods  
+
+    ##
+    # Class-level methods
+    module ClassMethods
       def reindex(id)
         find(id).reindex
-      rescue Blacklight::Exceptions::InvalidSolrID
-        # no-op
+      rescue Blacklight::Exceptions::InvalidSolrID => e
+        Rails.logger.debug "Unable to find document #{id}: #{e}"
       end
     end
 
-    def update current_exhibit, new_attributes
+    def update(current_exhibit, new_attributes)
       attributes = new_attributes.stringify_keys
 
-      if custom_data = attributes.delete("sidecar")
-        sidecar(current_exhibit).update(custom_data)
-      end
+      custom_data = attributes.delete('sidecar')
+      tags = attributes.delete('exhibit_tag_list')
+      resource_attributes = attributes.delete('uploaded_resource')
 
-      if tags = attributes.delete("exhibit_tag_list")
-        # Note: this causes a save
-        current_exhibit.tag(self, with: tags, on: :tags)
-      end
+      sidecar(current_exhibit).update(custom_data) if custom_data
 
-      if uploaded_resource? and resource_attributes = attributes.delete("uploaded_resource")
-        uploaded_resource.url = resource_attributes["url"] if resource_attributes["url"]
-        uploaded_resource.save
-      end
+      # Note: this causes a save
+      current_exhibit.tag(self, with: tags, on: :tags) if tags
+
+      update_exhibit_resource(resource_attributes) if uploaded_resource?
+    end
+
+    def update_exhibit_resource(resource_attributes)
+      return unless resource_attributes && resource_attributes['url']
+      uploaded_resource.update url: resource_attributes['url']
     end
 
     def reindex
       # no-op reindex implementation
     end
 
-    def sidecar exhibit
+    def sidecar(exhibit)
       sidecars.find_or_initialize_by exhibit: exhibit
     end
 
     def to_solr
-      { self.class.unique_key.to_sym => id }.reverse_merge(sidecars.inject({}) { |result, sidecar| result.merge(sidecar.to_solr) }).merge(tags_to_solr)
+      { self.class.unique_key.to_sym => id }.reverse_merge(sidecars.inject({}) { |a, e| a.merge(e.to_solr) }).merge(tags_to_solr)
     end
 
-    def self.solr_field_for_tagger tagger
-      ("#{Spotlight::Engine.config.solr_fields.prefix}#{tagger.class.model_name.param_key}_#{tagger.id}_tags" + Spotlight::Engine.config.solr_fields.string_suffix).to_sym
+    # rubocop:disable Metrics/LineLength
+    def self.solr_field_for_tagger(tagger)
+      :"#{Spotlight::Engine.config.solr_fields.prefix}#{tagger.class.model_name.param_key}_#{tagger.id}_tags#{Spotlight::Engine.config.solr_fields.string_suffix}"
     end
 
-    def self.visibility_field exhibit
-      ("#{Spotlight::Engine.config.solr_fields.prefix}#{exhibit.class.model_name.param_key}_#{exhibit.id}_public" + Spotlight::Engine.config.solr_fields.boolean_suffix).to_sym
+    def self.visibility_field(exhibit)
+      :"#{Spotlight::Engine.config.solr_fields.prefix}#{exhibit.class.model_name.param_key}_#{exhibit.id}_public#{Spotlight::Engine.config.solr_fields.boolean_suffix}"
     end
-    
+    # rubocop:enable Metrics/LineLength
+
     def self.resource_type_field
       :"#{Spotlight::Engine.config.solr_fields.prefix}spotlight_resource_type#{Spotlight::Engine.config.solr_fields.string_suffix}"
     end
 
-    def make_public! exhibit
+    def make_public!(exhibit)
       sidecar(exhibit).public!
     end
 
-    def make_private! exhibit
+    def make_private!(exhibit)
       sidecar(exhibit).private!
     end
 
-    def private? exhibit
+    def private?(exhibit)
       !(public?(exhibit))
     end
 
-    def public? exhibit
+    def public?(exhibit)
       sidecar(exhibit).public?
     end
 
     def uploaded_resource?
       self[Spotlight::SolrDocument.resource_type_field].present? &&
-      self[Spotlight::SolrDocument.resource_type_field].include?("spotlight/resources/uploads")
+        self[Spotlight::SolrDocument.resource_type_field].include?('spotlight/resources/uploads')
     end
 
-    def attribute_present? *args
+    def attribute_present?(*_args)
       false
     end
 
     protected
+
     def tags_to_solr
       h = {}
 
@@ -114,7 +121,6 @@ module Spotlight
       end
       h
     end
-
   end
 end
 

data/app/models/concerns/spotlight/solr_document/active_model_concern.rb

@@ -1,48 +1,37 @@
-module Spotlight::SolrDocument::ActiveModelConcern
-  extend ActiveSupport::Concern
-  
-  included do
-    include Spotlight::ArLight
-    extend ActiveModel::Callbacks
-    define_model_callbacks :save
-  end
-  
-  module ClassMethods
+module Spotlight
+  module SolrDocument
+    ##
+    # ActiveModel stubs to make {::SolrDocument}s work as activemodel objects
+    module ActiveModelConcern
+      extend ActiveSupport::Concern
 
-    # needed for Rails 4.1 + act_as_taggable
-    def dangerous_attribute_method? *args
-      false
-    end
-    
-    # needed for Rails 4.1 + act_as_taggable
-    def generated_association_methods
-      @generated_association_methods ||= begin
-        mod = const_set(:GeneratedAssociationMethods, Module.new)
-        include mod
-        mod
+      included do
+        include Spotlight::ArLight
+        extend ActiveModel::Callbacks
+        define_model_callbacks :save
       end
-    end
-  end
-  
-  def save
-    run_callbacks :save do
-      # no-op
-    end
-  end
 
-  def to_key
-    [id]
-  end
+      def save
+        run_callbacks :save do
+          # no-op
+        end
+      end
 
-  def persisted?
-    true
-  end
+      def to_key
+        [id]
+      end
 
-  def destroyed?
-    false
-  end
+      def persisted?
+        true
+      end
 
-  def new_record?
-    !persisted?
+      def destroyed?
+        false
+      end
+
+      def new_record?
+        !persisted?
+      end
+    end
   end
 end

data/app/models/concerns/spotlight/solr_document/atomic_updates.rb

@@ -1,25 +1,29 @@
-module Spotlight::SolrDocument::AtomicUpdates
+module Spotlight
+  module SolrDocument
+    ##
+    # Solr indexing strategy using Solr's Atomic Updates
+    module AtomicUpdates
+      def reindex
+        data = hash_for_solr_update(to_solr)
 
-  def reindex
-    data = hash_for_solr_update(to_solr)
+        blacklight_solr.update params: { commitWithin: 500 }, data: data.to_json, headers: { 'Content-Type' => 'application/json' } unless data.empty?
+      end
 
-    blacklight_solr.update params: { commitWithin: 500 }, data: data.to_json, headers: { 'Content-Type' => 'application/json'} unless data.empty?
-  end
+      private
 
-  private
-  def hash_for_solr_update data
-    data = [data] unless data.is_a? Array
+      def hash_for_solr_update(data)
+        Array.wrap(data).map { |doc| convert_document_to_atomic_update_hash(doc) }.reject { |x| x.length <= 1 }
+      end
 
-    data.map do |doc|
-      Hash[doc.map do |k,v|
-        val = if k.to_sym == self.class.unique_key.to_sym
-          v
-        else
-          { set: v }
+      def convert_document_to_atomic_update_hash(doc)
+        doc.each_with_object({}) do |(k, v), hash|
+          hash[k] = if k.to_sym == self.class.unique_key.to_sym
+                      v
+                    else
+                      { set: v }
+                    end
         end
-
-        [k,val]
-      end]
-    end.reject { |x| x.length <= 1 }
+      end
+    end
   end
 end

data/app/models/concerns/spotlight/solr_document/finder.rb

@@ -1,27 +1,32 @@
-module Spotlight::SolrDocument
-  module Finder
-    
-    extend ActiveSupport::Concern
+module Spotlight
+  module SolrDocument
+    ##
+    # Finder methods for SolrDocuments
+    module Finder
+      extend ActiveSupport::Concern
 
-    module ClassMethods
-      def find(id)
-        solr_response = index.find(id)
-        solr_response.documents.first
-      end
+      ##
+      # Class level finder methods for documents
+      module ClassMethods
+        def find(id)
+          solr_response = index.find(id)
+          solr_response.documents.first
+        end
 
-      def index
-        @index ||= blacklight_config.repository_class.new(blacklight_config)
-      end
+        def index
+          @index ||= blacklight_config.repository_class.new(blacklight_config)
+        end
 
-      protected 
+        protected
 
-      def blacklight_config
-        @conf ||= Spotlight::Engine.blacklight_config
+        def blacklight_config
+          @conf ||= Spotlight::Engine.blacklight_config
+        end
       end
-    end
 
-    def blacklight_solr
-      self.class.index.connection
+      def blacklight_solr
+        self.class.index.connection
+      end
     end
   end
 end

data/app/models/concerns/spotlight/solr_document/spotlight_images.rb

@@ -1,51 +1,55 @@
 ###
- # Simple concern mixed into SolrDocument to create
- # a mapping of configured Spotlight::ImageDerivatives
- # to their configured fields in the SolrDocument.
- # Any derivatives configured (descibed in Spotlight::ImageDerivatives)
- # will be available under #spotlight_image_versions and an array of available versions
- # (regardless of their is related data in the document) in the #spotlight_image_versions#versions array.
+# Simple concern mixed into SolrDocument to create
+# a mapping of configured Spotlight::ImageDerivatives
+# to their configured fields in the SolrDocument.
+# Any derivatives configured (descibed in Spotlight::ImageDerivatives)
+# will be available under #spotlight_image_versions and an array of available versions
+# (regardless of their is related data in the document) in the #spotlight_image_versions#versions array.
 ###
-module Spotlight::SolrDocument::SpotlightImages
-
-  def spotlight_image_versions
-    @spotlight_image_versions ||= Versions.new(self)
-  end
-
-  class Versions
-    include Spotlight::ImageDerivatives
-    attr_reader :versions, :document
-
-    def initialize(document)
-      @document = document
-      @versions = spotlight_image_derivatives.map do |derivative|
-        version = version_name(derivative)
-        self.class.send(:define_method, version) do
-          document[derivative[:field]]
-        end
-        version
+module Spotlight
+  module SolrDocument
+    ##
+    # Spotlight image derivatives helpers
+    module SpotlightImages
+      def spotlight_image_versions
+        @spotlight_image_versions ||= Versions.new(self)
       end
-    end
 
-    def image_versions *args
+      ##
+      # Spotlight image derivivative class
+      class Versions
+        include Spotlight::ImageDerivatives
+        attr_reader :versions, :document
+
+        def initialize(document)
+          @document = document
+          @versions = spotlight_image_derivatives.map do |derivative|
+            version = version_name(derivative)
+            self.class.send(:define_method, version) do
+              Array.wrap(document.fetch(derivative[:field], []))
+            end
+            version
+          end
+        end
 
-      self.send(args.first).each_with_index.map do |img, i|
-        args.inject({}) do |hash, version|
-          hash[version] = self.send(version)[i]
-          hash
+        def image_versions(*args)
+          send(args.first).each_with_index.map do |_img, i|
+            args.each_with_object({}) do |version, hash|
+              hash[version] = send(version)[i]
+            end
+          end
         end
-      end
-    end
 
-    private
+        private
 
-    def version_name(derivative)
-      derivative[:version] || default_version_name
-    end
+        def version_name(derivative)
+          derivative[:version] || default_version_name
+        end
 
-    def default_version_name
-      :full
+        def default_version_name
+          :full
+        end
+      end
     end
   end
-
 end

data/app/models/concerns/spotlight/solr_document/uploaded_resource.rb

@@ -1,35 +1,47 @@
-module Spotlight::SolrDocument::UploadedResource
-  extend ActiveSupport::Concern
+module Spotlight
+  module SolrDocument
+    ##
+    # Mixin for SolrDocuments backed by exhibit-specific resources
+    module UploadedResource
+      extend ActiveSupport::Concern
 
-  included do
-    accepts_nested_attributes_for :uploaded_resource
-  end
+      included do
+        accepts_nested_attributes_for :uploaded_resource
+      end
 
-  def uploaded_resource
-    @uploaded_resource ||= GlobalID::Locator.locate first(Spotlight::Resource.resource_global_id_field) rescue nil
-  end
+      def uploaded_resource
+        @uploaded_resource ||= GlobalID::Locator.locate first(Spotlight::Resource.resource_global_id_field)
+      rescue => e
+        Rails.logger.info("Unable to locate uploaded resource: #{e}")
+        nil
+      end
 
-  def to_openseadragon(*args)
-    self[Spotlight::Engine.config.full_image_field].each_with_index.map do |image_url, index|
-      {LegacyImagePyramidTileSource.new(
-         image_url,
-         {width: self[:spotlight_full_image_width_ssm][index],
-          height: self[:spotlight_full_image_height_ssm][index]}
-       ) => {}
-      } 
-    end
-  end
-  class LegacyImagePyramidTileSource
-    attr_reader :to_tilesource
-    def initialize(url, dimensions={})
-      @to_tilesource = {
-        type: 'legacy-image-pyramid',
-        levels:[{
-          url: url,
-          width: dimensions[:width],
-          height: dimensions[:height]
-        }]
-      }
+      def to_openseadragon(*_args)
+        self[Spotlight::Engine.config.full_image_field].each_with_index.map do |image_url, index|
+          { LegacyImagePyramidTileSource.new(
+            image_url,
+            width: self[:spotlight_full_image_width_ssm][index],
+            height: self[:spotlight_full_image_height_ssm][index]
+          ) => {}
+          }
+        end
+      end
+
+      ##
+      # Stub legacy image pyramid property generators
+      class LegacyImagePyramidTileSource
+        attr_reader :to_tilesource
+        def initialize(url, dimensions = {})
+          @to_tilesource = {
+            type: 'legacy-image-pyramid',
+            levels: [{
+              url: url,
+              width: dimensions[:width],
+              height: dimensions[:height]
+            }]
+          }
+        end
+      end
     end
   end
 end