blacklight-spotlight 0.12.0 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04d55db45686c960c104b415057758f0f890225a
-  data.tar.gz: a5fe69056e63432730a864d937e56337f1fa679f
+  metadata.gz: 04eb98fbaa9f7a11fbebb777f034d1537773bd2f
+  data.tar.gz: 8ced6a8356a1cb65c3ce5bbbf941108444b0fb7f
 SHA512:
-  metadata.gz: a4d9d682a2a7a8c4948ec1f92a7620019804fc5467bad97ad63b33c3e548e74845af3bb37e4a1b53b0fe6d475b00ffefc08b342b001ddb9ac5a992eaf4e49d92
-  data.tar.gz: f88c7ac71957e878187f799afd7f08bd54d7216bff08e7af74f05f7e1f9fc0624647e47cc1786f3c7bffa8225a407d80fe23061c3dded7ad2a722bfb30555803
+  metadata.gz: d9b5ea84c1d186ec0aab2fd47b59099c832caffd05ae6e151ab2088c71012ec76fec695cfaac258927ffb9cfaee9c2af388b11a3da06d704b8c251a984113294
+  data.tar.gz: 02290a5d60fc130bb1bbf96f335cd66e503a323436c48e207a631f468009d9ed5728911bfed807e5a818f8754eccaf16d4feffd2a47b796bf535036c37cbd3e6

data/app/controllers/spotlight/roles_controller.rb

@@ -33,7 +33,7 @@ module Spotlight
     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 ::User.where(email: exists_params).present?
+      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
@@ -41,7 +41,7 @@ module Spotlight
     end
 
     def invite
-      user = ::User.invite!(email: invite_params[:user], skip_invitation: true) # don't deliver the invitation yet
+      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])
       if role.save
         user.deliver_invitation # now deliver it when we have saved the role

data/app/models/spotlight/ability.rb

@@ -6,7 +6,7 @@ module Spotlight
 
     # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def initialize(user)
-      user ||= ::User.new
+      user ||= Spotlight::Engine.user_class.new
 
       alias_action :process_import, to: :import
 

data/app/models/spotlight/exhibit.rb

@@ -32,7 +32,7 @@ module Spotlight
     has_many :roles, 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: '::User'
+    has_many :users, through: :roles, class_name: Spotlight::Engine.config.user_class
     has_many :pages, dependent: :destroy
 
     has_one :blacklight_configuration, class_name: 'Spotlight::BlacklightConfiguration', dependent: :delete

data/app/models/spotlight/page.rb

@@ -8,8 +8,8 @@ module Spotlight
     friendly_id :title, use: [:slugged, :scoped, :finders, :history], scope: :exhibit
 
     belongs_to :exhibit, touch: true
-    belongs_to :created_by, class_name: '::User'
-    belongs_to :last_edited_by, class_name: '::User'
+    belongs_to :created_by, class_name: Spotlight::Engine.config.user_class
+    belongs_to :last_edited_by, class_name: Spotlight::Engine.config.user_class
     validates :weight, inclusion: { in: proc { 0..Spotlight::Page::MAX_PAGES } }
 
     default_scope { order('weight ASC') }

data/app/models/spotlight/resource.rb

@@ -18,7 +18,6 @@ module Spotlight
       :last_index_elapsed_time,
       :last_indexed_finished], coder: JSON
 
-    around_index :reindex_with_lock
     around_index :reindex_with_logging
     after_index :commit
 
@@ -134,12 +133,6 @@ module Spotlight
 
       protected
 
-      def reindex_with_lock
-        with_lock do
-          yield
-        end
-      end
-
       def reindex_with_logging
         time_start = Time.zone.now
 

data/app/models/spotlight/role.rb

@@ -4,7 +4,7 @@ module Spotlight
   class Role < ActiveRecord::Base
     ROLES = %w(admin curator)
     belongs_to :exhibit
-    belongs_to :user, class_name: '::User', autosave: true
+    belongs_to :user, class_name: Spotlight::Engine.config.user_class, autosave: true
     validates :role, inclusion: { in: ROLES }
     validates :user_key, presence: true
     validate :user_must_exist, if: -> { user_key.present? }
@@ -21,7 +21,7 @@ module Spotlight
     # setting user key causes the user to get set
     def user_key=(key)
       @user_key = key
-      self.user ||= ::User.find_by_user_key(key)
+      self.user ||= Spotlight::Engine.user_class.find_by_user_key(key)
       user.user_key = key if user
     end
 

data/app/models/spotlight/search.rb

@@ -19,20 +19,15 @@ module Spotlight
     accepts_nested_attributes_for :thumbnail, update_only: true
     accepts_nested_attributes_for :masthead, update_only: true
 
-    include Blacklight::SearchHelper
-    include Spotlight::Catalog::AccessControlsEnforcement
-
     def thumbnail_image_url
       thumbnail.image.thumb.url if thumbnail && thumbnail.image
     end
 
-    def count
-      repository.search(search_builder.with(query_params).rows(0).merge(facet: false))['response']['numFound']
-    end
-
     def images
-      documents.map do |doc|
-        [
+      return enum_for(:images) { documents.size } unless block_given?
+
+      documents.each do |doc|
+        yield [
           doc.first(blacklight_config.document_model.unique_key),
           doc.first(blacklight_config.index.title_field),
           doc.first(blacklight_config.index.thumbnail_field)
@@ -41,10 +36,15 @@ module Spotlight
     end
 
     def documents
-      return enum_for(:documents) unless block_given?
+      start = 0
+      response = repository.search(search_params.start(start))
+
+      return to_enum(:documents) { response['response']['numFound'] } unless block_given?
 
-      Blacklight::Solr::Response.new(solr_response, {}).docs.each do |result|
-        yield blacklight_config.document_model.new(result)
+      while response.documents.present?
+        response.documents.each { |x| yield x }
+        start += response.documents.length
+        response = repository.search(search_params.start(start))
       end
     end
 
@@ -67,15 +67,22 @@ module Spotlight
       end
     end
 
+    def search_params
+      search_builder.with(query_params.with_indifferent_access).merge(facet: false, fl: default_search_fields)
+    end
+
     private
 
-    def solr_response
-      @solr_response ||= repository.search(
-        search_builder.with(query_params).rows(1000).merge(
-          facet: false,
-          fl: default_search_fields
-        )
-      )
+    def search_builder_class
+      blacklight_config.search_builder_class
+    end
+
+    def search_builder
+      search_builder_class.new(true, self)
+    end
+
+    def repository
+      Blacklight.default_index
     end
 
     def default_search_fields

data/app/serializers/spotlight/page_representer.rb

@@ -12,8 +12,8 @@ module Spotlight
     property :content, exec_context: :decorator
 
     def content
-      # get the sir-trevor objects as JSON.
-      represented.content.as_json
+      # get the original data, bypassing any Sir-Trevor transformations
+      represented.read_attribute(:content)
     end
 
     delegate :content=, to: :represented

data/app/views/spotlight/browse/_search.html.erb

@@ -1,4 +1,4 @@
-<%= cache [@exhibit, search, search.count] do %>
+<%= cache [@exhibit, search, search.documents.size] do %>
   <div class="col-sm-4 col-xs-12 category">
     <%= link_to spotlight.exhibit_browse_path(@exhibit, search) do %>
       <div class="image-overlay">
@@ -6,7 +6,7 @@
         <div class="text-overlay">
            <h2 class="browse-category-title">
              <%= search.title%>
-             <small><%= t :'spotlight.browse.search.item_count', count: search.count %></small>
+             <small><%= t :'spotlight.browse.search.item_count', count: search.documents.size %></small>
            </h2>
          </div>
       </div>

data/app/views/spotlight/browse/_search_title.html.erb

@@ -1,2 +1,2 @@
 <h1><%= search.title %></h1>
-<small class="item-count"><%= t :'spotlight.browse.search.item_count', count: search.count %></small>
+<small class="item-count"><%= t :'spotlight.browse.search.item_count', count: search.documents.size %></small>

data/app/views/spotlight/searches/_search.html.erb

@@ -8,7 +8,7 @@
       <div class="pic thumbnail"><%= image_tag(search.thumbnail.image.thumb) if search.thumbnail %></div>
       <div class="main">
         <div class="title panel-title"><%= search.title %></div>
-        <div class="count"><%= t :'.item_count', count: search.count %></div>
+        <div class="count"><%= t :'.item_count', count: search.documents.size %></div>
         <div class="actions"><%= exhibit_view_link(search) %> &bull; <%= exhibit_edit_link(search) %> &bull; <%= exhibit_delete_link(search) %></div>
         <%= f.hidden_field :id %>
         <%= f.hidden_field :weight, data: {property: "weight"} %>

data/config/locales/devise.en.yml

@@ -0,0 +1,5 @@
+en:
+  devise:
+    mailer:
+      invitation_instructions:
+        subject: 'Exhibit invitation instructions'

data/config/locales/spotlight.en.yml

@@ -264,9 +264,9 @@ en:
     invitation_mailer:
       invitation_instructions:
         hello: "Hello %{email}!"
-        someone_invited_you: "The Exhibits Administrator has invited to be a member of '%{exhibit_name}' at %{url}. You can accept it through the link below."
+        someone_invited_you: "The Exhibits Administrator has invited you to help work on the \"%{exhibit_name}\" exhibit at %{url}. You can accept this invitation by clicking the link below."
         accept: "Accept invitation"
-        ignore_html: "If you don't want to accept the invitation, please ignore this email.<br />Your account won't be created until you access the link above."
+        ignore_html: "If you don't want to accept the invitation, please ignore this email. Your account won't be created until you access the link above."
     confirmation_mailer:
       confirmation_instructions:
         welcome: "Welcome %{email}!"

data/db/migrate/20151110082345_add_metadata_to_spotlight_resource.rb

@@ -1,5 +1,9 @@
 class AddMetadataToSpotlightResource < ActiveRecord::Migration
   def up
-    add_column :spotlight_resources, :metadata, :blob
+    add_column :spotlight_resources, :metadata, :binary
+  end
+
+  def down
+    remove_column :spotlight_resources, :metadata
   end
 end

data/db/migrate/20151210073829_create_spotlight_configuration.rb

@@ -0,0 +1,7 @@
+class CreateSpotlightConfiguration < ActiveRecord::Migration
+  def change
+    create_table :spotlight_configurations do |t|
+      t.references :masthead
+    end
+  end
+end

data/lib/spotlight/engine.rb

@@ -47,6 +47,10 @@ module Spotlight
       FactoryGirl.definition_file_paths << File.expand_path('../../../spec/factories', __FILE__) if defined?(FactoryGirl)
     end
 
+    def self.user_class
+      Spotlight::Engine.config.user_class.constantize
+    end
+
     def self.catalog_controller
       Spotlight::Engine.config.catalog_controller_class.constantize
     end
@@ -55,6 +59,8 @@ module Spotlight
       Spotlight::Engine.config.default_blacklight_config || catalog_controller.blacklight_config
     end
 
+    Spotlight::Engine.config.user_class = '::User'
+
     Spotlight::Engine.config.catalog_controller_class = '::CatalogController'
     Spotlight::Engine.config.default_blacklight_config = nil
 

data/lib/spotlight/version.rb

@@ -1,4 +1,4 @@
 #
 module Spotlight
-  VERSION = '0.12.0'
+  VERSION = '0.12.1'
 end

data/lib/tasks/spotlight_tasks.rake

@@ -60,7 +60,7 @@ namespace :spotlight do
   end
 
   def prompt_to_create_user
-    User.find_or_create_by!(email: prompt_for_email) do |u|
+    Spotlight::Engine.user_class.find_or_create_by!(email: prompt_for_email) do |u|
       puts 'User not found. Enter a password to create the user.'
       u.password = prompt_for_password
     end

data/spec/controllers/spotlight/roles_controller_spec.rb

@@ -101,9 +101,9 @@ describe Spotlight::RolesController, type: :controller do
       it 'invites the selected user' do
         expect do
           post :invite, exhibit_id: exhibit, user: 'user@example.com', role: 'curator'
-        end.to change { ::User.count }.by(1)
-        expect(::User.last.roles.length).to eq 1
-        expect(::User.last.roles.first.exhibit).to eq exhibit
+        end.to change { Spotlight::Engine.user_class.count }.by(1)
+        expect(Spotlight::Engine.user_class.last.roles.length).to eq 1
+        expect(Spotlight::Engine.user_class.last.roles.first.exhibit).to eq exhibit
       end
 
       it 'adds the user to the exhibit via a role' do

data/spec/models/spotlight/search_spec.rb

@@ -1,8 +1,10 @@
 require 'spec_helper'
 
 describe Spotlight::Search, type: :model do
+  let(:exhibit) { FactoryGirl.create(:exhibit) }
+
   let(:query_params) { { 'f' => { 'genre_sim' => ['map'] } } }
-  subject { FactoryGirl.create(:exhibit).searches.build(title: 'Search', query_params: query_params) }
+  subject { exhibit.searches.build(title: 'Search', query_params: query_params) }
 
   let(:blacklight_config) { ::CatalogController.blacklight_config }
   let(:document) do
@@ -15,8 +17,6 @@ describe Spotlight::Search, type: :model do
                      blacklight_config.index.title_field => 'title')
   end
 
-  it { is_expected.to be_a Spotlight::Catalog::AccessControlsEnforcement }
-
   context 'thumbnail' do
     it 'calls DefaultThumbnailJob to fetch a default feature image' do
       expect(Spotlight::DefaultThumbnailJob).to receive(:perform_later).with(subject)
@@ -40,14 +40,18 @@ describe Spotlight::Search, type: :model do
     end
   end
 
-  it 'has items' do
-    expect(subject.count).to eq 55
-  end
+  describe 'for a search matching all items' do
+    let(:query_params) { {} }
 
-  it 'has images' do
-    expect(subject.images.size).to eq(55)
-    expect(subject.images.map(&:last)).to include 'https://stacks.stanford.edu/image/dq287tq6352/dq287tq6352_05_0001_thumb',
-                                                  'https://stacks.stanford.edu/image/jp266yb7109/jp266yb7109_05_0001_thumb'
+    it 'has items' do
+      expect(subject.documents.size).to eq 55
+    end
+
+    it 'has images' do
+      expect(subject.images.size).to eq(55)
+      expect(subject.images.map(&:last)).to include 'https://stacks.stanford.edu/image/dq287tq6352/dq287tq6352_05_0001_thumb',
+                                                    'https://stacks.stanford.edu/image/jp266yb7109/jp266yb7109_05_0001_thumb'
+    end
   end
 
   describe 'default_scope' do
@@ -79,4 +83,20 @@ describe Spotlight::Search, type: :model do
       end
     end
   end
+
+  describe '#search_params' do
+    it 'maps the search to the appropriate facet values' do
+      expect(subject.search_params.to_hash).to include 'fq' => array_including('{!raw f=genre_sim}map')
+    end
+
+    context 'with filter_resources_by_exhibit configured' do
+      before do
+        allow(Spotlight::Engine.config).to receive(:filter_resources_by_exhibit).and_return(true)
+      end
+
+      it 'includes the exhibit context' do
+        expect(subject.search_params.to_hash).to include 'fq' => array_including("spotlight_exhibit_slug_#{exhibit.slug}_bsi:true")
+      end
+    end
+  end
 end

data/spec/serializers/spotlight/exhibit_export_serializer_spec.rb

@@ -189,6 +189,7 @@ describe Spotlight::ExhibitExportSerializer do
       let(:thumbnail) { FactoryGirl.create(:featured_image) }
 
       before do
+        feature_page.content = { data: [{ type: 'text', data: { text: 'xyz' } }] }.to_json
         feature_page.thumbnail = thumbnail
         feature_page.save
       end
@@ -199,8 +200,14 @@ describe Spotlight::ExhibitExportSerializer do
       end
 
       it 'copies the thumbnail' do
-        expect(subject.searches.first.thumbnail).not_to be_blank
-        expect(subject.searches.first.thumbnail.image.file.path).not_to eq source_exhibit.searches.first.thumbnail.image.file.path
+        expect(subject.feature_pages.first.thumbnail).not_to be_blank
+        expect(subject.feature_pages.first.thumbnail.image.file.path).not_to eq source_exhibit.feature_pages.first.thumbnail.image.file.path
+      end
+
+      it 'copies the content' do
+        expect(JSON.parse(subject.feature_pages.first.read_attribute(:content))).to have_key 'data'
+        expect(subject.feature_pages.first.content.length).to eq 1
+        expect(subject.feature_pages.first.content.first).to be_a_kind_of SirTrevorRails::Blocks::TextBlock
       end
     end
 

data/spec/spec_helper.rb

@@ -59,7 +59,7 @@ RSpec.configure do |config|
     DatabaseCleaner.start
 
     # The first user is automatically granted admin privileges; we don't want that behavior for many of our tests
-    User.create email: 'initial+admin@example.com', password: 'password', password_confirmation: 'password'
+    Spotlight::Engine.user_class.create email: 'initial+admin@example.com', password: 'password', password_confirmation: 'password'
   end
 
   config.after do

data/spec/views/_user_util_links.html.erb_spec.rb

@@ -32,7 +32,7 @@ module Spotlight
     end
 
     describe 'when user is logged in' do
-      let(:current_user) { ::User.new }
+      let(:current_user) { Spotlight::Engine.user_class.new }
       it 'renders the links' do
         render
         expect(rendered).to have_link 'Feedback'
@@ -42,7 +42,7 @@ module Spotlight
     end
 
     describe 'when user is a curator' do
-      let(:current_user) { ::User.new }
+      let(:current_user) { Spotlight::Engine.user_class.new }
       before do
         allow(view).to receive(:can?).with(:update, current_exhibit).and_return(false)
         allow(view).to receive(:can?).with(:create, Spotlight::Exhibit).and_return(false)
@@ -56,7 +56,7 @@ module Spotlight
       end
     end
     describe 'when user is an admin' do
-      let(:current_user) { ::User.new }
+      let(:current_user) { Spotlight::Engine.user_class.new }
       before do
         allow(view).to receive(:can?).with(:update, current_exhibit).and_return(true)
         allow(view).to receive(:can?).with(:create, Spotlight::Exhibit).and_return(false)
@@ -71,7 +71,7 @@ module Spotlight
     end
 
     describe 'when user is a site-wide admin' do
-      let(:current_user) { ::User.new }
+      let(:current_user) { Spotlight::Engine.user_class.new }
       before do
         allow(view).to receive(:can?).with(:update, current_exhibit).and_return(true)
         allow(view).to receive(:can?).with(:create, Spotlight::Exhibit).and_return(true)

data/spec/views/spotlight/browse/_search.html.erb_spec.rb

@@ -4,7 +4,7 @@ describe 'spotlight/browse/search', type: :view do
   let(:search) { FactoryGirl.create(:search) }
   let(:exhibit) { FactoryGirl.create(:exhibit) }
   before :each do
-    allow(search).to receive_messages(count: 15)
+    allow(search).to receive_messages(documents: double(size: 15))
     allow(search).to receive_message_chain(:thumbnail, :image, thumb: '/some/image')
   end
 
@@ -24,6 +24,6 @@ describe 'spotlight/browse/search', type: :view do
 
   it 'displays the item count' do
     render partial: 'spotlight/browse/search', locals: { search: search }
-    expect(response).to have_selector 'small', text: /#{search.count} items/i
+    expect(response).to have_selector 'small', text: /#{search.documents.size} items/i
   end
 end

data/spec/views/spotlight/browse/show.html.erb_spec.rb

@@ -8,7 +8,7 @@ describe 'spotlight/browse/show', type: :view do
     allow(view).to receive_messages(exhibit_masthead?: true)
     allow(view).to receive_messages(blacklight_config: Blacklight::Configuration.new)
     view.blacklight_config.view.gallery = true
-    allow(search).to receive_messages(count: 15)
+    allow(search).to receive_messages(documents: double(size: 15))
     allow(view).to receive_messages(render_document_index_with_view: '')
     stub_template('_results_pagination.html.erb' => '')
     stub_template('_sort_and_per_page.html.erb' => 'Sort and Per Page actions')
@@ -23,14 +23,14 @@ describe 'spotlight/browse/show', type: :view do
   it 'has a heading and item count when there is no current search masthead' do
     render
     expect(response).to have_selector 'h1', text: search.title
-    expect(response).to have_selector '.item-count', text: "#{search.count} items"
+    expect(response).to have_selector '.item-count', text: "#{search.documents.size} items"
   end
 
   it 'does not have the heading and item count when there is a current search masthead' do
     allow(view).to receive_messages(exhibit_masthead?: false)
     render
     expect(response).to_not have_selector 'h1', text: search.title
-    expect(response).to_not have_selector '.item-count', text: "#{search.count} items"
+    expect(response).to_not have_selector '.item-count', text: "#{search.documents.size} items"
   end
 
   it 'has an edit button' do

data/spec/views/spotlight/exhibits/index.html.erb_spec.rb

@@ -4,7 +4,7 @@ module Spotlight
   describe 'spotlight/exhibits/index', type: :view do
     let(:exhibits) { Spotlight::Exhibit.none }
     let(:ability) { ::Ability.new(user) }
-    let(:user) { ::User.new }
+    let(:user) { Spotlight::Engine.user_class.new }
 
     before do
       assign(:exhibits, exhibits)

data/spec/views/spotlight/roles/index.html.erb_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module Spotlight
   describe 'spotlight/roles/index', type: :view do
-    let(:user) { stub_model(::User, email: 'jane@example.com') }
+    let(:user) { stub_model(Spotlight::Engine.user_class, email: 'jane@example.com') }
 
     let(:exhibit) { FactoryGirl.create(:exhibit) }
     let(:admin_role) { FactoryGirl.create(:role, role: 'admin', user: user, exhibit: exhibit) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-spotlight
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.12.1
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -1058,6 +1058,7 @@ files:
 - app/views/spotlight/sir_trevor/blocks/videos/_youtube.html.erb
 - app/views/spotlight/tags/index.html.erb
 - config/jetty.yml
+- config/locales/devise.en.yml
 - config/locales/social_share_button.en.yml
 - config/locales/spotlight.en.yml
 - config/routes.rb
@@ -1097,6 +1098,7 @@ files:
 - db/migrate/20151124101123_remove_default_from_spotlight_exhibit.rb
 - db/migrate/20151124105543_update_custom_field_names.rb
 - db/migrate/20151208085432_add_weight_to_exhibits.rb
+- db/migrate/20151210073829_create_spotlight_configuration.rb
 - lib/blacklight/spotlight.rb
 - lib/generators/spotlight/install_generator.rb
 - lib/generators/spotlight/templates/catalog_controller.rb