blacklight-spotlight 0.34.1 → 1.0.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b8049b771f549a0ba4549ba177511365d4c47a2
-  data.tar.gz: 62cb02a402b05b63c6dbe6b0a112a77b46297d4c
+  metadata.gz: c850274c191873929f87b2e3bbc6459ff8508317
+  data.tar.gz: 871d6f41e445137655c2bb45ee01a466b5ffcb56
 SHA512:
-  metadata.gz: 0bb7738f311a695969355a30098a3730989e8c3d9d2802c6a155cf1e7412cdbc7b453c89c63a6380aba77a859be846895d8ca44650181a5c0975b20a5cb9b285
-  data.tar.gz: 336c43cdced351a17ea4640f6238309f03756cc7471372d7d615a23279757d59360ef21210902ad40e9e5ba100f232e6492ea0976701fa2ae9f3be3e05c3f9be
+  metadata.gz: 3319d9fb7fe3bbbdd381c89e0144e048be7607580e777dd405f676bd16eae0e288d98cf7d67b3156ac2e6c8d1873cd01c8d37957a832ac71e4301e011009ecbf
+  data.tar.gz: 9b8a2f3d86c4e04ae579c3dac5324aed5eb859d0c2940b5ead8135fa6680eb3d4d28d96f2f3aa9e02b96c7760b3a4b27cff458967d1c34678216378f1d7d679e

data/README.md

@@ -10,7 +10,7 @@ Read more about what Spotlight is, our motivations for creating it, and how to i
 ## Requirements
 
 1. Ruby (2.2.0 or greater)
-2. Rails (4.2.0 or greater)
+2. Rails (5.0 or greater)
 3. Java (7 or greater) *for Solr*
 4. ImageMagick (http://www.imagemagick.org/script/index.php) due to [carrierwave](https://github.com/carrierwaveuploader/carrierwave#adding-versions)
 

data/app/assets/javascripts/spotlight/pages.js.erb

@@ -7,7 +7,7 @@ Spotlight.onLoad(function(){
     uploadUrl: $('[data-attachment-endpoint]').data('attachment-endpoint'),
     ajaxOptions: {
       headers: {
-        'X-CSRF-Token': $.rails.csrfToken() || ''
+        'X-CSRF-Token': (Rails || $.rails).csrfToken() || ''
       },
       credentials: 'same-origin'
     }

data/app/controllers/concerns/spotlight/controller.rb

@@ -8,7 +8,6 @@ module Spotlight
 
     included do
       helper_method :current_site, :current_exhibit, :current_masthead, :exhibit_masthead?, :resource_masthead?
-      helper_method :redirect_back # helper method backported from Rails 5
     end
 
     def current_site
@@ -86,16 +85,5 @@ module Spotlight
       options = Blacklight::Parameters.sanitize(params.to_unsafe_h.with_indifferent_access).merge(options).except(:exhibit_id, :only_path)
       spotlight.facet_exhibit_catalog_url(current_exhibit, *args, options)
     end
-
-    # Backport from Rails 5
-    def redirect_back(fallback_location:, **args)
-      if defined?(super)
-        super
-      elsif request.headers['Referer']
-        redirect_to request.headers['Referer'], **args
-      else
-        redirect_to fallback_location, **args
-      end
-    end
   end
 end

data/app/helpers/spotlight/crop_helper.rb

@@ -27,11 +27,7 @@ module Spotlight
     end
 
     def form_prefix(f)
-      if Rails::VERSION::MAJOR >= 5
-        f.object_name.parameterize(separator: '_')
-      else
-        f.object_name.parameterize('_')
-      end
+      f.object_name.parameterize(separator: '_')
     end
   end
 end

data/app/models/concerns/spotlight/resources/open_graph.rb

@@ -27,11 +27,7 @@ module Spotlight
       private
 
       def opengraph_solr_field_name(field)
-        if Rails::VERSION::MAJOR >= 5
-          field.parameterize(separator: '_')
-        else
-          field.parameterize('_')
-        end
+        field.parameterize(separator: '_')
       end
     end
   end

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

@@ -4,19 +4,10 @@ module Spotlight
   module SolrDocument
     extend ActiveSupport::Concern
 
-    include Spotlight::SolrDocument::ActiveModelConcern
     include Spotlight::SolrDocument::Finder
     include GlobalID::Identification
 
     included do
-      extend ActsAsTaggableOn::Taggable
-
-      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, &:uploaded_resource?)
     end
 
@@ -24,7 +15,7 @@ module Spotlight
     # Class-level methods
     module ClassMethods
       def build_for_exhibit(id, exhibit, attributes = {})
-        new(unique_key => id) do |doc|
+        new(unique_key => id).tap do |doc|
           doc.sidecar(exhibit).tap { |x| x.assign_attributes(attributes) }.save! # save is a nop if the sidecar isn't modified.
         end
       end
@@ -66,11 +57,15 @@ module Spotlight
       sidecar(current_exhibit).update(custom_data) if custom_data
 
       # Note: this causes a save
-      current_exhibit.tag(self, with: tags, on: :tags) if tags
+      current_exhibit.tag(sidecar(current_exhibit), with: tags, on: :tags) if tags
 
       update_exhibit_resource(resource_attributes) if uploaded_resource?
     end
 
+    def save
+      reindex
+    end
+
     def update_exhibit_resource(resource_attributes)
       return unless resource_attributes && resource_attributes['url']
       uploaded_resource.upload.update image: resource_attributes['url']
@@ -80,8 +75,12 @@ module Spotlight
       # no-op reindex implementation
     end
 
+    def sidecars
+      Spotlight::SolrDocumentSidecar.where(document_id: id, document_type: self.class.to_s)
+    end
+
     def sidecar(exhibit)
-      sidecars.find_or_initialize_by exhibit: exhibit
+      sidecars.find_or_initialize_by exhibit: exhibit, document_id: id, document_type: self.class.to_s
     end
 
     def to_solr
@@ -118,16 +117,14 @@ module Spotlight
     def tags_to_solr
       h = {}
 
-      # Adding a placeholder entry in case the last tag for an exhibit
-      # is removed, so we clear out the solr field too.
-      Spotlight::Exhibit.find_each do |exhibit|
-        h[self.class.solr_field_for_tagger(exhibit)] = nil
-      end
+      sidecars.each do |sidecar|
+        h[self.class.solr_field_for_tagger(sidecar.exhibit)] = nil
 
-      taggings.includes(:tag, :tagger).map do |tagging|
-        key = self.class.solr_field_for_tagger(tagging.tagger)
-        h[key] ||= []
-        h[key] << tagging.tag.name
+        sidecar.taggings.includes(:tag, :tagger).map do |tagging|
+          key = self.class.solr_field_for_tagger(tagging.tagger)
+          h[key] ||= []
+          h[key] << tagging.tag.name
+        end
       end
       h
     end
@@ -135,7 +132,7 @@ module Spotlight
 end
 
 ActsAsTaggableOn::Tagging.after_destroy do |obj|
-  if obj.tagger.is_a? Spotlight::Exhibit
-    obj.tagger.blacklight_config.document_model.reindex(obj.taggable_id)
+  if obj.tagger.is_a?(Spotlight::Exhibit) && obj.taggable.is_a?(Spotlight::SolrDocumentSidecar)
+    obj.tagger.blacklight_config.document_model.reindex(obj.taggable.document_id)
   end
 end

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

@@ -38,6 +38,22 @@ module Spotlight
         end
       end
 
+      # Returns true if +comparison_object+ is the same exact object, or +comparison_object+
+      # is of the same type and +self+ has an ID and it is equal to +comparison_object.id+.
+      #
+      # Note that new records are different from any other record by definition, unless the
+      # other record is the receiver itself. Besides, if you fetch existing records with
+      # +select+ and leave the ID out, you're on your own, this predicate will return false.
+      #
+      # Note also that destroying a record preserves its ID in the model instance, so deleted
+      # models are still comparable.
+      def ==(other)
+        super ||
+          (other.instance_of?(self.class) &&
+            id &&
+            other.id == id)
+      end
+
       def blacklight_solr
         self.class.index.connection
       end

data/app/models/spotlight/blacklight_configuration.rb

@@ -5,7 +5,7 @@ module Spotlight
   # Exhibit-specific blacklight configuration model
   # rubocop:disable Metrics/ClassLength
   class BlacklightConfiguration < ActiveRecord::Base
-    belongs_to :exhibit, touch: true
+    belongs_to :exhibit, touch: true, optional: true
     serialize :facet_fields, Hash
     serialize :index_fields, Hash
     serialize :search_fields, Hash
@@ -198,7 +198,7 @@ module Spotlight
     # rubocop:enable Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
     def custom_index_fields
-      Hash[exhibit.custom_fields.map do |x|
+      Hash[exhibit.custom_fields.reject(&:new_record?).map do |x|
         field = Blacklight::Configuration::IndexField.new x.configuration.merge(
           key: x.field, field: x.solr_field, custom_field: true
         )
@@ -207,12 +207,13 @@ module Spotlight
     end
 
     def custom_facet_fields
-      Hash[exhibit.custom_fields.vocab.map do |x|
+      Hash[exhibit.custom_fields.vocab.reject(&:new_record?).map do |x|
         field = Blacklight::Configuration::FacetField.new x.configuration.merge(
           key: x.field, field: x.solr_field, show: false, custom_field: true
         )
         field.if = :field_enabled?
         field.enabled = false
+        field.limit = true
         [x.field, field]
       end]
     end
@@ -344,14 +345,7 @@ module Spotlight
     end
 
     def value_to_boolean(v)
-      if defined? ActiveModel::Type::Boolean
-        ActiveModel::Type::Boolean.new.cast v
-      elsif defined? ActiveRecord::Type::Boolean
-        # Rails 4.2+
-        ActiveRecord::Type::Boolean.new.type_cast_from_database v
-      else
-        ActiveRecord::ConnectionAdapters::Column.value_to_boolean v
-      end
+      ActiveModel::Type::Boolean.new.cast v
     end
   end
 end

data/app/models/spotlight/contact.rb

@@ -2,7 +2,7 @@ module Spotlight
   ##
   # Exhibit curator contact information
   class Contact < ActiveRecord::Base
-    belongs_to :exhibit, touch: true
+    belongs_to :exhibit, touch: true, optional: true
     scope :published, -> { where(show_in_sidebar: true) }
     default_scope { order('weight ASC') }
     serialize :contact_info, Hash
@@ -10,7 +10,7 @@ module Spotlight
     extend FriendlyId
     friendly_id :name, use: [:slugged, :scoped, :finders], scope: :exhibit
 
-    belongs_to :avatar, class_name: 'Spotlight::ContactImage', dependent: :destroy
+    belongs_to :avatar, class_name: 'Spotlight::ContactImage', dependent: :destroy, optional: true
     accepts_nested_attributes_for :avatar, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
 
     before_save do

data/app/models/spotlight/custom_field.rb

@@ -3,7 +3,7 @@ module Spotlight
   # Exhibit custom fields
   class CustomField < ActiveRecord::Base
     serialize :configuration, Hash
-    belongs_to :exhibit
+    belongs_to :exhibit, optional: true
 
     extend FriendlyId
     friendly_id :slug_candidates, use: [:slugged, :scoped, :finders], scope: :exhibit

data/app/models/spotlight/exhibit.rb

@@ -45,9 +45,9 @@ module Spotlight
     has_one :blacklight_configuration, class_name: 'Spotlight::BlacklightConfiguration', dependent: :delete
     has_one :home_page
 
-    belongs_to :site
-    belongs_to :masthead, dependent: :destroy
-    belongs_to :thumbnail, class_name: 'Spotlight::ExhibitThumbnail', dependent: :destroy
+    belongs_to :site, optional: true
+    belongs_to :masthead, dependent: :destroy, optional: true
+    belongs_to :thumbnail, class_name: 'Spotlight::ExhibitThumbnail', dependent: :destroy, optional: true
 
     accepts_nested_attributes_for :about_pages, :attachments, :contacts, :custom_fields, :feature_pages,
                                   :main_navigations, :owned_taggings, :resources, :searches, :solr_document_sidecars

data/app/models/spotlight/feature_page.rb

@@ -6,11 +6,11 @@ module Spotlight
     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'
+    belongs_to :parent_page, class_name: 'Spotlight::FeaturePage', optional: true
 
     accepts_nested_attributes_for :child_pages
 
-    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy
+    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy, optional: true
     accepts_nested_attributes_for :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
 
     before_validation unless: :top_level_page? do

data/app/models/spotlight/field_metadata.rb

@@ -12,11 +12,11 @@ module Spotlight
       @blacklight_config = blacklight_config
     end
 
-    def field(field_name)
+    def field(key)
       {
-        document_count: document_counts.fetch(field_name, 0),
-        value_count: terms.fetch(field_name, []).length,
-        terms: terms.fetch(field_name, [])
+        document_count: document_counts.fetch(field_name(key), 0),
+        value_count: terms.fetch(field_name(key), []).length,
+        terms: terms.fetch(field_name(key), [])
       }
     end
 
@@ -26,6 +26,14 @@ module Spotlight
 
     private
 
+    def field_name(key)
+      if blacklight_config.facet_fields[key]
+        blacklight_config.facet_fields[key].field
+      else
+        key
+      end
+    end
+
     def search_builder_class
       blacklight_config.search_builder_class
     end

data/app/models/spotlight/filter.rb

@@ -24,14 +24,7 @@ module Spotlight
     end
 
     def value_to_boolean(v)
-      if defined? ActiveModel::Type::Boolean
-        ActiveModel::Type::Boolean.new.cast v
-      elsif defined? ActiveRecord::Type::Boolean
-        # Rails 4.2+
-        ActiveRecord::Type::Boolean.new.type_cast_from_database v
-      else
-        ActiveRecord::ConnectionAdapters::Column.value_to_boolean v
-      end
+      ActiveModel::Type::Boolean.new.cast v
     end
   end
 end

data/app/models/spotlight/lock.rb

@@ -3,7 +3,7 @@ module Spotlight
   # Page-level locking to discourage update conflicts
   class Lock < ActiveRecord::Base
     belongs_to :on, polymorphic: true
-    belongs_to :by, polymorphic: true
+    belongs_to :by, polymorphic: true, optional: true
 
     def current_session!
       @current_session = true

data/app/models/spotlight/page.rb

@@ -8,9 +8,9 @@ module Spotlight
     friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: :exhibit
 
     belongs_to :exhibit, touch: true
-    belongs_to :created_by, class_name: Spotlight::Engine.config.user_class
-    belongs_to :last_edited_by, class_name: Spotlight::Engine.config.user_class
-    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy
+    belongs_to :created_by, class_name: Spotlight::Engine.config.user_class, optional: true
+    belongs_to :last_edited_by, class_name: Spotlight::Engine.config.user_class, optional: true
+    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy, optional: true
 
     validates :weight, inclusion: { in: proc { 0..Spotlight::Page::MAX_PAGES } }
 

data/app/models/spotlight/reindexing_log_entry.rb

@@ -5,7 +5,7 @@ module Spotlight
     enum job_status: { unstarted: 0, in_progress: 1, succeeded: 2, failed: 3 }
 
     belongs_to :exhibit, class_name: 'Spotlight::Exhibit'
-    belongs_to :user, class_name: '::User'
+    belongs_to :user, class_name: '::User', optional: true
 
     # null start times sort to the top, to more easily surface pending reindexing
     default_scope { order('start_time IS NOT NULL, start_time DESC') }

data/app/models/spotlight/resource.rb

@@ -68,7 +68,7 @@ module Spotlight
       private
 
       def blacklight_solr
-        @solr ||= RSolr.connect(connection_config)
+        @solr ||= RSolr.connect(connection_config.merge(adapter: connection_config[:http_adapter]))
       end
 
       def connection_config

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

@@ -4,7 +4,7 @@ module Spotlight
     ##
     # Exhibit-specific resources, created using uploaded and custom fields
     class Upload < Spotlight::Resource
-      belongs_to :upload, class_name: 'Spotlight::FeaturedImage'
+      belongs_to :upload, class_name: 'Spotlight::FeaturedImage', optional: true
 
       # we want to do this before reindexing
       after_create :update_document_sidecar

data/app/models/spotlight/role.rb

@@ -3,11 +3,9 @@ module Spotlight
   # Exhibit authorization roles
   class Role < ActiveRecord::Base
     ROLES = %w(admin curator).freeze
-    belongs_to :resource, polymorphic: true
-    belongs_to :user, class_name: Spotlight::Engine.config.user_class, autosave: true
+    belongs_to :resource, polymorphic: true, optional: true
+    belongs_to :user, class_name: Spotlight::Engine.config.user_class, autosave: true, required: 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
@@ -22,17 +20,12 @@ module Spotlight
     def user_key=(key)
       @user_key = key
       self.user ||= Spotlight::Engine.user_class.find_by_user_key(key)
-      user.user_key = key if user
+      self.user ||= Spotlight::Engine.user_class.invite!(email: user_key, skip_invitation: true)
+      user.user_key = key
     end
 
     protected
 
-    def user_must_exist
-      return if user.present?
-
-      self.user ||= Spotlight::Engine.user_class.invite!(email: user_key, skip_invitation: true)
-    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

data/app/models/spotlight/search.rb

@@ -13,8 +13,8 @@ module Spotlight
     validates :title, presence: true
     has_paper_trail
 
-    belongs_to :masthead, dependent: :destroy
-    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy
+    belongs_to :masthead, dependent: :destroy, optional: true
+    belongs_to :thumbnail, class_name: 'Spotlight::FeaturedImage', dependent: :destroy, optional: true
     accepts_nested_attributes_for :thumbnail, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }
     accepts_nested_attributes_for :masthead, update_only: true, reject_if: proc { |attr| attr['iiif_tilesource'].blank? }