blacklight-spotlight 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b45039dfeb64f44d24665c3b2fbabef264eca86
-  data.tar.gz: 8d3f3015e3b61bbd5d185903b82af1c17a3c302a
+  metadata.gz: 8cddcc5a9f2a5d68c50a7092eec103a1fd4e4ff2
+  data.tar.gz: a368d7becced90f589111c22c2dbf2b5311d1aa8
 SHA512:
-  metadata.gz: 2d146ecf16f66315c47f81ef1e1f7a5a911cc0cb9989955a30bb64707e2a9a4b762b849578481ff0021b78d44998382265718f1c13e9af92e5a6a63482a23891
-  data.tar.gz: 14e5e9cb7329342bc6c8ed68cdd2bfae3e22f8e0efcc66d1c4297a26bb7b49a88924ba7f6a6ad0b51f4e37c05292354cc9ccfb12ffc427a2b03a769b2c59efa0
+  metadata.gz: b39192c1b349d0b10f7f9968ee2683e6c62aadb203069e28eb41cf9165a6dbf527bf2870a06639298ba52cbacd29a0e6b042e43be5a7136a956ebeaf6ef3a818
+  data.tar.gz: 113f4f169e3a1ea853e39417e5a96c49e2b3492c311f3f161d35187b917d759a5b999886f44df3cce2abfe36b1b07a597bebea6e85dcdfe4f4ba432425c68724

data/app/assets/javascripts/spotlight/check_user_existence.js

@@ -10,8 +10,7 @@
 
     function checkIfUserExists() {
       target = $(this);
-      var form = target.closest('form');
-      if (target.val() !== '' && form[0].checkValidity()) {
+      if (target.val() !== '' && form()[0].checkValidity()) {
         $.ajax(userExistsUrl())
          .success(userExists)
          .fail(userDoesNotExist);
@@ -42,26 +41,34 @@
       var link = noUserNote().find('a');
       var originalHref = link.data('inviteUrl');
       var userName = target.val();
-      var role = roleSelect().val();
       link.attr(
         'href',
-        originalHref + '?user=' + encodeURIComponent(userName) + '&role=' + encodeURIComponent(role)
+        originalHref + '?user=' + encodeURIComponent(userName) + '&role=' + encodeURIComponent(roleValue())
       );
     }
 
+    function roleValue() {
+      if (roleSelect().length > 0) {
+        return roleSelect().val();
+      } else {
+        return target.closest('tr').find('[data-user-role]').data('userRole');
+      }
+    }
+
     function roleSelect() {
       return target.closest('tr').find('select');
     }
 
     function noUserNote() {
-      return target.closest('td')
-                   .find('[data-behavior="no-user-note"]');
+      return form().find('[data-behavior="no-user-note"]');
     }
 
     function submitButton() {
-      return target.closest('tr')
-                   .next('tr')
-                   .find('input[type="submit"]');
+      return form().find('input[type="submit"]');
+    }
+
+    function form() {
+      return target.closest('form');
     }
 
     function userExistsUrl() {

data/app/assets/javascripts/spotlight/tabs.js

@@ -0,0 +1,6 @@
+Spotlight.onLoad(function(){
+  if ($('[role=tabpanel]').length > 0 && window.location.hash) {
+    var tabpanel = $(window.location.hash).closest('[role=tabpanel]');
+    $('a[role=tab][href=#'+tabpanel.attr('id')+']').tab('show');  
+  }
+});

data/app/assets/javascripts/spotlight/users.js

@@ -75,5 +75,5 @@
 
 
 Spotlight.onLoad(function() {
-  $('.edit_exhibit').spotlight_users();
+  $('.edit_exhibit, .admin-users').spotlight_users();
 });

data/app/assets/stylesheets/spotlight/_upload.scss

@@ -1,5 +0,0 @@
-.item-upload-tabs {
-  .tab-content {
-    margin-top: $padding-large-vertical;
-  }
-}

data/app/controllers/spotlight/admin_users_controller.rb

@@ -0,0 +1,49 @@
+module Spotlight
+  ##
+  # A controller to handle the adminstration of site admin users
+  class AdminUsersController < Spotlight::ApplicationController
+    include Spotlight::Concerns::UserExistable
+    include Spotlight::Concerns::UserInvitable
+
+    before_action :authenticate_user!
+    before_action :load_site
+    load_and_authorize_resource :site, class: 'Spotlight::Site'
+
+    def index
+    end
+
+    def create
+      if update_roles
+        flash[:notice] = t('spotlight.admin_users.create.success')
+      else
+        flash[:error] = t('spotlight.admin_users.create.error')
+      end
+      redirect_to spotlight.admin_users_path
+    end
+
+    def destroy
+      user = Spotlight::Engine.user_class.find(params[:id])
+      if user.roles.where(resource: @site).first.destroy
+        flash[:notice] = t('spotlight.admin_users.destroy.success')
+      else
+        flash[:error] = t('spotlight.admin_users.destroy.error')
+      end
+      redirect_to spotlight.admin_users_path
+    end
+
+    private
+
+    def load_site
+      @site ||= Spotlight::Site.instance
+    end
+
+    def create_params
+      params.require(:user).permit(:email)
+    end
+
+    def update_roles
+      user = Spotlight::Engine.user_class.where(email: create_params[:email]).first
+      Spotlight::Role.create(user: user, role: 'admin', resource: @site).save
+    end
+  end
+end

data/app/controllers/spotlight/catalog_controller.rb

@@ -36,13 +36,6 @@ module Spotlight
       blacklight_config.view.edit.partials.insert(2, :edit)
     end
 
-    def new
-      add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
-      add_breadcrumb t(:'spotlight.curation.sidebar.items'), admin_exhibit_catalog_index_path(@exhibit)
-      add_breadcrumb t(:'spotlight.catalog.new.header'), new_exhibit_catalog_path(@exhibit)
-      @resource = @exhibit.resources.build
-    end
-
     def show
       super
 

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

@@ -0,0 +1,24 @@
+module Spotlight
+  module Concerns
+    ###
+    # Mixin to be included into controllers that provides a
+    # method to check if a particular user exists in the site
+    module UserExistable
+      def exists
+        # note: the messages returned are not shown to users and really only useful for debug, hence no translation necessary
+        #  app uses html status code to act on response
+        if Spotlight::Engine.user_class.where(email: exists_params).present?
+          render json: { message: 'User exists' }
+        else
+          render json: { message: 'User does not exist' }, status: :not_found
+        end
+      end
+
+      protected
+
+      def exists_params
+        params.require(:user)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Spotlight
+  module Concerns
+    ###
+    # Mixin to be included into controllers that provides an action which
+    # allows admins and curators to invite users and assign them a role.
+    module UserInvitable
+      def invite
+        # skip_invitation stops the immediate delivery of the invitation
+        user = Spotlight::Engine.user_class.invite!(email: invite_params[:user], skip_invitation: true)
+        role = Spotlight::Role.create(resource: exhibit_or_site, 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.invite.invited')
+        else
+          redirect_to :back, alert: t(:'helpers.submit.role.batch_error')
+        end
+      end
+
+      protected
+
+      def invite_params
+        params.permit(:user, :role)
+      end
+
+      def exhibit_or_site
+        current_exhibit || @site
+      end
+    end
+  end
+end

data/app/controllers/spotlight/exhibits_controller.rb

@@ -8,6 +8,9 @@ module Spotlight
     load_and_authorize_resource
 
     def index
+      @published_exhibits = @exhibits.published.page(params[:page])
+      @published_exhibits = @published_exhibits.tagged_with(params[:tag]) if params[:tag]
+
       if @exhibits.one?
         redirect_to @exhibits.first
       else

data/app/controllers/spotlight/resources/csv_upload_controller.rb

@@ -0,0 +1,42 @@
+require 'csv'
+
+module Spotlight
+  module Resources
+    ##
+    # Creating new exhibit items from single-item entry forms
+    # or batch CSV upload
+    class CsvUploadController < ApplicationController
+      helper :all
+
+      before_action :authenticate_user!
+
+      load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
+
+      def create
+        file = csv_params[:url]
+        csv = CSV.parse(file.read, headers: true, return_headers: false, encoding: 'utf-8').map(&:to_hash)
+        Spotlight::AddUploadsFromCSV.perform_later(csv, current_exhibit, current_user)
+        flash[:notice] = t('spotlight.resources.upload.csv.success', file_name: file.original_filename)
+        redirect_to :back
+      end
+
+      def template
+        render text: CSV.generate { |csv| csv << data_param_keys.unshift(:url) }, content_type: 'text/csv'
+      end
+
+      private
+
+      def build_resource
+        @resource ||= Spotlight::Resources::Upload.new exhibit: current_exhibit
+      end
+
+      def csv_params
+        params.require(:resources_csv_upload).permit(:url)
+      end
+
+      def data_param_keys
+        Spotlight::Resources::Upload.fields(current_exhibit).map(&:field_name) + current_exhibit.custom_fields.map(&:field)
+      end
+    end
+  end
+end

data/app/controllers/spotlight/resources/upload_controller.rb

@@ -1,6 +1,3 @@
-# encoding: utf-8
-require 'csv'
-
 module Spotlight
   module Resources
     ##
@@ -12,15 +9,9 @@ module Spotlight
       before_action :authenticate_user!
 
       load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
-      before_action :build_resource, only: [:new, :create, :template]
+      before_action :build_resource
 
       load_and_authorize_resource class: 'Spotlight::Resources::Upload', through_association: 'exhibit.resources', instance_name: 'resource'
-      def new
-        add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), exhibit_root_path(@exhibit)
-        add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
-        add_breadcrumb t(:'spotlight.curation.sidebar.items'), admin_exhibit_catalog_index_path(@exhibit)
-        add_breadcrumb t(:'spotlight.resources.upload.new.header'), new_exhibit_resources_upload_path(@exhibit)
-      end
 
       # rubocop:disable Metrics/MethodLength
       def create
@@ -29,7 +20,7 @@ module Spotlight
         if @resource.save_and_index
           flash[:notice] = t('spotlight.resources.upload.success')
           if params['add-and-continue']
-            redirect_to new_exhibit_resources_upload_path(@resource.exhibit)
+            redirect_to new_exhibit_resource_path(@resource.exhibit, anchor: :new_resources_upload)
           else
             redirect_to admin_exhibit_catalog_index_path(@resource.exhibit, sort: :timestamp)
           end
@@ -40,28 +31,12 @@ module Spotlight
       end
       # rubocop:enable Metrics/MethodLength
 
-      def csv_upload
-        file = csv_params[:url]
-        csv = CSV.parse(file.read, headers: true, return_headers: false, encoding: 'utf-8').map(&:to_hash)
-        Spotlight::AddUploadsFromCSV.perform_later(csv, current_exhibit, current_user)
-        flash[:notice] = t('spotlight.resources.upload.csv.success', file_name: file.original_filename)
-        redirect_to :back
-      end
-
-      def template
-        render text: CSV.generate { |csv| csv << data_param_keys.unshift(:url) }, content_type: 'text/csv'
-      end
-
       private
 
       def build_resource
         @resource ||= Spotlight::Resources::Upload.new exhibit: current_exhibit
       end
 
-      def csv_params
-        params.require(:resources_csv_upload).permit(:url)
-      end
-
       def resource_params
         params.require(:resources_upload).permit(:url, data: data_param_keys)
       end

data/app/controllers/spotlight/resources_controller.rb

@@ -8,36 +8,23 @@ module Spotlight
     before_action :build_resource, only: [:create]
 
     load_and_authorize_resource through: :exhibit
-    helper_method :from_popup?
 
     def new
-      @resource.attributes = resource_params if params[:resource]
-      @resource = @resource.becomes_provider
+      add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), exhibit_root_path(@exhibit)
+      add_breadcrumb t(:'spotlight.curation.sidebar.header'), exhibit_dashboard_path(@exhibit)
+      add_breadcrumb t(:'spotlight.curation.sidebar.items'), admin_exhibit_catalog_index_path(@exhibit)
+      add_breadcrumb t(:'spotlight.resources.new.header'), new_exhibit_resource_path(@exhibit)
 
-      ## TODO: in Rails 4.1, replace this with a variant
-      if from_popup?
-        render layout: 'spotlight/popup'
-      else
-        render
-      end
+      render
     end
 
-    # rubocop:disable Metrics/MethodLength
     def create
-      @resource.attributes = resource_params
-      @resource = @resource.becomes_provider
-
       if @resource.save_and_index
-        if from_popup?
-          render layout: false, text: '<html><script>window.close();</script></html>'
-        else
-          redirect_to admin_exhibit_catalog_index_path(@resource.exhibit, sort: :timestamp)
-        end
+        redirect_to admin_exhibit_catalog_index_path(@resource.exhibit, sort: :timestamp)
       else
         render action: 'new'
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     def monitor
       render json: current_exhibit.reindex_progress
@@ -56,11 +43,7 @@ module Spotlight
     end
 
     def build_resource
-      @resource ||= @exhibit.resources.build(resource_params).becomes_provider
-    end
-
-    def from_popup?
-      params.fetch(:popup, false)
+      @resource ||= @exhibit.resources.build(resource_params)
     end
   end
 end

data/app/controllers/spotlight/roles_controller.rb

@@ -3,6 +3,8 @@ module Spotlight
   # CRUD actions for assigning exhibit roles to
   # existing users
   class RolesController < Spotlight::ApplicationController
+    include Spotlight::Concerns::UserExistable
+    include Spotlight::Concerns::UserInvitable
     before_action :authenticate_user!
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
     load_and_authorize_resource through: :exhibit, except: [:update_all]
@@ -30,41 +32,12 @@ module Spotlight
       end
     end
 
-    def exists
-      # note: the messages returned are not shown to users and really only useful for debug, hence no translation necessary
-      #  app uses html status code to act on response
-      if Spotlight::Engine.user_class.where(email: exists_params).present?
-        render json: { message: 'User exists' }
-      else
-        render json: { message: 'User does not exist' }, status: :not_found
-      end
-    end
-
-    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(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')
-      else
-        redirect_to :back, alert: t(:'helpers.submit.role.batch_error')
-      end
-    end
-
     protected
 
     def exhibit_params
       params.require(:exhibit).permit(roles_attributes: [:id, :user_key, :role, :_destroy])
     end
 
-    def invite_params
-      params.permit(:user, :role)
-    end
-
-    def exists_params
-      params.require(:user)
-    end
-
     # When nested attributes are passed in, ensure we have authorization to update each row.
     # @param attr [Hash,Array] the nested attributes
     # @param klass [Class] the class that is getting created

data/app/models/spotlight/exhibit.rb

@@ -10,6 +10,8 @@ module Spotlight
     scope :published, -> { where(published: true) }
     scope :unpublished, -> { where(published: false) }
 
+    paginates_per 50
+
     extend FriendlyId
     friendly_id :title, use: [:slugged, :finders]
     validates :title, presence: true

data/app/models/spotlight/resource.rb

@@ -24,20 +24,6 @@ module Spotlight
     after_index :commit
     after_index :completed!
 
-    def becomes_provider
-      klass = Spotlight::ResourceProvider.for_resource(self)
-
-      if klass
-        self.becomes! klass
-      else
-        self
-      end
-    end
-
-    def needs_provider?
-      type.blank?
-    end
-
     ##
     # Persist the record to the database, and trigger a reindex to solr
     #