blacklight-spotlight 0.13.0 → 0.14.0

data/app/controllers/spotlight/resources_controller.rb

@@ -39,6 +39,10 @@ module Spotlight
     end
     # rubocop:enable Metrics/MethodLength
 
+    def monitor
+      render json: current_exhibit.reindex_progress
+    end
+
     def reindex_all
       @exhibit.reindex_later
 

data/app/controllers/spotlight/roles_controller.rb

@@ -42,7 +42,7 @@ module Spotlight
 
     def invite
       user = Spotlight::Engine.user_class.invite!(email: invite_params[:user], skip_invitation: true) # don't deliver the invitation yet
-      role = Spotlight::Role.create(exhibit: current_exhibit, user: user, role: invite_params[:role])
+      role = Spotlight::Role.create(resource: current_exhibit, user: user, role: invite_params[:role])
       if role.save
         user.deliver_invitation # now deliver it when we have saved the role
         redirect_to :back, notice: t(:'helpers.submit.role.updated')

data/app/controllers/spotlight/sites_controller.rb

@@ -0,0 +1,50 @@
+module Spotlight
+  ##
+  # Global site configuration
+  class SitesController < Spotlight::ApplicationController
+    before_action :authenticate_user!
+    before_action :load_site
+    load_and_authorize_resource
+
+    def edit
+    end
+
+    def edit_exhibits
+    end
+
+    def update
+      if @site.update(site_params)
+        redirect_to exhibits_path, notice: t(:'helpers.submit.site.updated', model: @site.class.model_name.human.downcase)
+      else
+        flash[:alert] = @site.errors.full_messages.join('<br>'.html_safe)
+        render action: :edit
+      end
+    end
+
+    private
+
+    def load_site
+      @site ||= Spotlight::Site.instance
+    end
+
+    def site_params
+      params.require(:site).permit(
+        :title,
+        :subtitle,
+        masthead_attributes: masthead_params,
+        exhibits_attributes: [:id, :weight]
+      )
+    end
+
+    def masthead_params
+      [
+        :display,
+        :source,
+        :image,
+        :remote_image_url,
+        :document_global_id,
+        :image_crop_x, :image_crop_y, :image_crop_w, :image_crop_h
+      ]
+    end
+  end
+end

data/app/helpers/spotlight/application_helper.rb

@@ -9,7 +9,8 @@ module Spotlight
     ##
     # Give the application name a chance to include the exhibit title
     def application_name
-      name = super
+      name = current_site.title if current_site.title.present?
+      name ||= super
 
       if current_exhibit
         t :'spotlight.application_name', exhibit: current_exhibit.title, application_name: name

data/app/helpers/spotlight/navbar_helper.rb

@@ -7,7 +7,7 @@ module Spotlight
     # if the exhibit is not searchable, we're not in an exhibit, or the top-level
     # exhibit masthead isn't being used (e.g. on a browse category)
     def should_render_spotlight_search_bar?
-      exhibit_masthead? && current_exhibit && current_exhibit.searchable?
+      current_exhibit && current_exhibit.searchable?
     end
   end
 end

data/app/jobs/spotlight/reindex_job.rb

@@ -4,16 +4,25 @@ module Spotlight
   class ReindexJob < ActiveJob::Base
     queue_as :default
 
+    before_enqueue do |job|
+      resource_list(job.arguments.first).each(&:waiting!)
+    end
+
     def perform(exhibit_or_resources)
-      resources = if exhibit_or_resources.is_a? Spotlight::Exhibit
-                    exhibit_or_resources.resources.find_each
-                  elsif exhibit_or_resources.is_a? Enumerable
-                    exhibit_or_resources
-                  else
-                    Array(exhibit_or_resources)
-                  end
+      resource_list(exhibit_or_resources).each(&:reindex)
+    end
+
+    private
 
-      resources.each(&:reindex)
+    def resource_list(exhibit_or_resources)
+      case
+      when exhibit_or_resources.is_a?(Spotlight::Exhibit)
+        exhibit_or_resources.resources.find_each
+      when exhibit_or_resources.is_a?(Enumerable)
+        exhibit_or_resources
+      else
+        Array(exhibit_or_resources)
+      end
     end
   end
 end

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

@@ -5,21 +5,25 @@ module Spotlight
     extend ActiveSupport::Concern
     included do
       has_many :roles, class_name: 'Spotlight::Role', dependent: :destroy
-      has_many :exhibits, class_name: 'Spotlight::Exhibit', through: :roles
+      has_many :exhibits, class_name: 'Spotlight::Exhibit', through: :roles, source: 'resource', source_type: 'Spotlight::Exhibit'
 
       before_create :add_default_roles
     end
 
     def superadmin?
-      admin_roles.where(exhibit_id: nil).any?
+      roles.where(role: 'admin', resource: Spotlight::Site.instance).any?
+    end
+
+    def exhibit_roles
+      roles.where(resource_type: 'Spotlight::Exhibit')
     end
 
     def admin_roles
-      roles.where(role: 'admin')
+      exhibit_roles.where(role: 'admin')
     end
 
     def add_default_roles
-      roles.build role: 'admin' unless self.class.any?
+      roles.build role: 'admin', resource: Spotlight::Site.instance unless self.class.any?
     end
 
     def invite_pending?

data/app/models/spotlight/ability.rb

@@ -13,8 +13,9 @@ module Spotlight
       can :manage, :all if user.superadmin?
 
       # exhibit admin
-      can [:update, :import, :export, :destroy], Spotlight::Exhibit, id: user.admin_roles.pluck(:exhibit_id)
-      can :manage, [Spotlight::BlacklightConfiguration, Spotlight::Role], exhibit_id: user.admin_roles.pluck(:exhibit_id)
+      can [:update, :import, :export, :destroy], Spotlight::Exhibit, id: user.admin_roles.pluck(:resource_id)
+      can :manage, Spotlight::BlacklightConfiguration, exhibit_id: user.admin_roles.pluck(:resource_id)
+      can :manage, Spotlight::Role, resource_id: user.admin_roles.pluck(:resource_id), resource_type: 'Spotlight::Exhibit'
 
       can :manage, PaperTrail::Version if user.roles.any?
 
@@ -25,11 +26,11 @@ module Spotlight
         Spotlight::Resource,
         Spotlight::Page,
         Spotlight::Contact,
-        Spotlight::CustomField], exhibit_id: user.roles.pluck(:exhibit_id)
+        Spotlight::CustomField], exhibit_id: user.exhibit_roles.pluck(:resource_id)
 
       can :manage, Spotlight::Lock, by: user
 
-      can [:read, :curate, :tag], Spotlight::Exhibit, id: user.roles.pluck(:exhibit_id)
+      can [:read, :curate, :tag], Spotlight::Exhibit, id: user.exhibit_roles.pluck(:resource_id)
 
       # public
       can :read, Spotlight::HomePage

data/app/models/spotlight/exhibit.rb

@@ -29,7 +29,7 @@ module Spotlight
     has_many :main_navigations, dependent: :delete_all
     has_many :owned_taggings, class_name: 'ActsAsTaggableOn::Tagging', as: :tagger
     has_many :resources
-    has_many :roles, dependent: :delete_all
+    has_many :roles, as: :resource, dependent: :delete_all
     has_many :searches, dependent: :destroy, extend: FriendlyId::FinderMethods
     has_many :solr_document_sidecars, dependent: :delete_all
     has_many :users, through: :roles, class_name: Spotlight::Engine.config.user_class
@@ -38,6 +38,7 @@ 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::FeaturedImage', dependent: :destroy
 
@@ -49,6 +50,7 @@ module Spotlight
 
     before_save :sanitize_description, if: :description_changed?
     before_create :build_home_page
+    before_create :add_site_reference
     after_create :initialize_config
     after_create :initialize_browse
     after_create :initialize_main_navigation
@@ -93,8 +95,20 @@ module Spotlight
       self.thumbnail ||= searches.first.try(:thumbnail)
     end
 
+    def requested_by
+      roles.first.user if roles.first
+    end
+
+    def reindex_progress
+      @reindex_progress ||= ReindexProgress.new(resources.order('updated_at')) if resources
+    end
+
     protected
 
+    def add_site_reference
+      self.site ||= Spotlight::Site.instance
+    end
+
     def initialize_config
       self.blacklight_configuration ||= Spotlight::BlacklightConfiguration.create!
     end

data/app/models/spotlight/reindex_progress.rb

@@ -0,0 +1,107 @@
+module Spotlight
+  ##
+  # ReindexProgress is a class that models the progress of reindexing a list of resources
+  class ReindexProgress
+    def initialize(resource_list)
+      @resources = if resource_list.present?
+                     resource_list
+                   else
+                     null_resources
+                   end
+    end
+
+    def in_progress?
+      return unless finished
+      any_waiting? || finished > Spotlight::Engine.config.reindex_progress_window.minutes.ago
+    end
+
+    def started
+      @started ||= resources.first.indexed_at
+    end
+
+    def finished
+      @finished ||= completed_resources.last.updated_at
+    end
+
+    def total
+      @total ||= resources.map(&:last_indexed_estimate).sum
+    end
+
+    def completed
+      @completed ||= completed_resources.map(&:last_indexed_count).sum
+    end
+
+    def errored?
+      resources.any?(&:errored?)
+    end
+
+    def as_json(*)
+      {
+        in_progress: in_progress?,
+        started: localized_start_time,
+        total: total,
+        completed: completed,
+        updated_at: localized_finish_time,
+        errored: errored?
+      }
+    end
+
+    private
+
+    attr_reader :resources
+
+    def any_waiting?
+      resources.any?(&:waiting?)
+    end
+
+    def localized_start_time
+      return unless started
+      I18n.l(started, format: :short)
+    end
+
+    def localized_finish_time
+      return unless finished
+      I18n.l(finished, format: :short)
+    end
+
+    def completed_resources
+      if resources.try(:completed).present?
+        resources.completed
+      else
+        null_resources
+      end
+    end
+
+    def null_resources
+      [NullResource.new]
+    end
+
+    ##
+    # A NullObject for use in the absense of resources
+    class NullResource
+      def updated_at
+        nil
+      end
+
+      def indexed_at
+        nil
+      end
+
+      def last_indexed_estimate
+        0
+      end
+
+      def last_indexed_count
+        0
+      end
+
+      def waiting?
+        false
+      end
+
+      def errored?
+        false
+      end
+    end
+  end
+end

data/app/models/spotlight/resource.rb

@@ -18,8 +18,11 @@ module Spotlight
       :last_index_elapsed_time,
       :last_indexed_finished], coder: JSON
 
+    enum index_status: [:waiting, :completed, :errored]
+
     around_index :reindex_with_logging
     after_index :commit
+    after_index :completed!
 
     def becomes_provider
       klass = Spotlight::ResourceProvider.for_resource(self)
@@ -46,6 +49,7 @@ module Spotlight
     ##
     # Enqueue an asynchronous reindexing job for this resource
     def reindex_later
+      waiting!
       Spotlight::ReindexJob.perform_later(self)
     end
 

data/app/models/spotlight/role.rb

@@ -3,7 +3,7 @@ module Spotlight
   # Exhibit authorization roles
   class Role < ActiveRecord::Base
     ROLES = %w(admin curator)
-    belongs_to :exhibit
+    belongs_to :resource, polymorphic: true
     belongs_to :user, class_name: Spotlight::Engine.config.user_class, autosave: true
     validates :role, inclusion: { in: ROLES }
     validates :user_key, presence: true
@@ -35,7 +35,7 @@ module Spotlight
     #    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?
+      errors.add(:user_key, 'already a member of this exhibit') if Spotlight::Role.where(resource: resource, user: user).where.not(id: id).any?
     end
   end
 end

data/app/models/spotlight/site.rb

@@ -0,0 +1,16 @@
+module Spotlight
+  ##
+  # Global spotlight configuration
+  class Site < ActiveRecord::Base
+    has_many :exhibits
+    has_many :roles, as: :resource
+
+    belongs_to :masthead, dependent: :destroy
+
+    accepts_nested_attributes_for :masthead, :exhibits
+
+    def self.instance
+      first || create
+    end
+  end
+end

data/app/views/devise/mailer/invitation_instructions.html.erb

@@ -1,6 +1,6 @@
 <p><%= t("spotlight.invitation_mailer.invitation_instructions.hello", email: @resource.email) %></p>
 
-<p><%= t("spotlight.invitation_mailer.invitation_instructions.someone_invited_you", role: @resource.roles.first.role, exhibit_name: @resource.roles.first.exhibit.title, url: spotlight.exhibit_home_page_url(@resource.roles.first.exhibit)) %></p>
+<p><%= t("spotlight.invitation_mailer.invitation_instructions.someone_invited_you", role: @resource.roles.first.role, exhibit_name: @resource.roles.first.resource.title, url: spotlight.exhibit_home_page_url(@resource.roles.first.resource)) %></p>
 
 <p><%= link_to t("spotlight.invitation_mailer.invitation_instructions.accept"), accept_invitation_url(@resource, :invitation_token => @token) %></p>
 

data/app/views/layouts/spotlight/spotlight.html.erb

@@ -31,7 +31,7 @@
   </head>
   <body class="<%= render_body_class %>">
   <%= render partial: 'shared/header_navbar' %>
-  <%= render partial: 'shared/exhibit_masthead_and_navbar' %>
+  <%= render partial: 'shared/masthead' %>
   <%= content_for?(:header_content) ? yield(:header_content) : "" %>
 
   <%= render partial: 'shared/ajax_modal' %>

data/app/views/shared/_breadcrumbs.html.erb

@@ -1,4 +1,4 @@
-<div class="container">
+<div class="container breadcrumbs-container">
   <div class="row">
     <div class="col-md-12">
       <%= render_breadcrumbs builder: Spotlight::BootstrapBreadcrumbsBuilder %>

data/app/views/shared/_exhibit_navbar.html.erb

@@ -1,14 +1,13 @@
-<div id="exhibit-navbar" class="navbar navbar-default<%= ' page-masthead' unless exhibit_masthead? %>" role="navigation">
+<div id="exhibit-navbar" class="exhibit-navbar navbar navbar-default" role="navigation">
   <div class="container">
-    <% unless exhibit_masthead? %>
+    <% if resource_masthead? %>
       <%= link_to(current_exhibit.title, spotlight.exhibit_path(current_exhibit), class: 'navbar-brand') %>
     <% end %>
+
     <ul class="nav navbar-nav">
-      <% if current_exhibit %>
-        <li class="<%= "active" if current_page?(current_exhibit) %>"><%= link_to t(:'spotlight.curation.nav.home'), current_exhibit %></li>
-        <% current_exhibit.main_navigations.displayable.each do |navigation| %>
-          <%= render partial: "shared/#{navigation.nav_type}_navbar", locals: {navigation: navigation} %>
-        <% end %>
+      <li class="<%= "active" if current_page?(current_exhibit) %>"><%= link_to t(:'spotlight.curation.nav.home'), current_exhibit %></li>
+      <% current_exhibit.main_navigations.displayable.each do |navigation| %>
+        <%= render partial: "shared/#{navigation.nav_type}_navbar", locals: { navigation: navigation } %>
       <% end %>
     </ul>
     <% if should_render_spotlight_search_bar? %>