blacklight-spotlight 0.4.1 → 0.5.0

data/app/views/spotlight/sir_trevor/blocks/_solr_documents_features_block.html.erb

@@ -7,9 +7,9 @@
   <div id="<%= html_id %>" class="row carousel" data-ride="carousel"  data-interval="false">
       <div class="col-sm-6">
         <div class="carousel-inner">
-          <% solr_documents_features_block.documents.each_with_index do |document, index| %>
+          <% solr_documents_features_block.each_document.each_with_index do |(block_options, document), index| %>
             <div class="item <%= 'active' if index == 0 %>" data-id="<%= document.id %>">
-              <% if block_thumb = solr_documents_features_block.document_options(document.id)[:full_image_url] %>
+              <% if block_thumb = block_options[:full_image_url] %>
                 <%= link_to_document(document, image_tag(block_thumb), counter: -1) %>
               <% elsif has_thumbnail? document %>
                 <%= render_thumbnail_tag(document, {}, document_counter: -1) %>

data/app/views/spotlight/sir_trevor/blocks/_solr_documents_grid_block.html.erb

@@ -1,10 +1,10 @@
 <% solr_documents_grid_block.with_solr_helper(self) %>
-<div class="content-block item-grid-block row">
-  <div class="items-col col-md-9 pull-<%= solr_documents_grid_block.content_align %>">
+<div class="content-block items-block item-grid-block row">
+  <div class="items-col <%= solr_documents_grid_block.text? ? 'col-md-9' : 'col-md-12' %> pull-<%= solr_documents_grid_block.content_align %>">
     <% if solr_documents_grid_block.documents? %>
-        <% solr_documents_grid_block.documents.each_with_index do |document, index| %>
+        <% solr_documents_grid_block.each_document.each_with_index do |(block_options, document), index| %>
           <div class="box item-<%= index %>" data-id="<%= document.id %>">
-            <% if block_thumb = solr_documents_grid_block.document_options(document.id)[:thumbnail_image_url] %>
+            <% if block_thumb = block_options[:thumbnail_image_url] %>
               <div class="thumbnail"><%= link_to_document(document, image_tag(block_thumb), counter: -1) %></div>
             <% elsif has_thumbnail? document %>
               <div class="thumbnail"><%= render_thumbnail_tag(document, {}, document_counter: -1) %></div>
@@ -14,8 +14,13 @@
     <% end %>
   </div>
 
-  <div class="text-col col-md-3 pull-<%= solr_documents_grid_block.text_align %>">
-    <h3><%= solr_documents_grid_block.title %></h3>
-    <%= sir_trevor_markdown solr_documents_grid_block.text %>
-  </div>
-</div>
+
+  <% if solr_documents_grid_block.text? %>
+    <div class="text-col col-md-3">
+      <% unless solr_documents_grid_block.title.blank? %>
+        <h3><%= solr_documents_grid_block.title %></h3>
+      <% end %>
+      <%= sir_trevor_markdown solr_documents_grid_block.text %>
+    </div>
+  <% end %>
+</div>

data/config/locales/spotlight.en.yml

@@ -37,7 +37,6 @@ en:
         batch_updated: "%{model} were successfully updated."
         batch_error: "There was an error updating the requested %{model}."
         destroyed: "The %{model} was deleted."
-      appearance: *spotlight_default
       contact:
         create: "Save"
         created: "The %{model} was created."
@@ -70,8 +69,6 @@ en:
       solr_document: *spotlight_default
       users: *spotlight_default
       custom_field: *spotlight_default
-      resource_csv:
-        create: "Import"
       role:
         updated: "User has been updated."
         destroyed: "User has been removed."
@@ -84,8 +81,6 @@ en:
       spotlight:
         page: Page
     attributes:
-      "spotlight/resource/csv":
-            url: "File"
       "spotlight/contact":
           avatar: "Photo"
       "spotlight/page":
@@ -117,20 +112,23 @@ en:
     appearances:
       edit:
         header: Appearance
-        document_index_view_types: Result page types
-        default_per_page: Default results per page
         exhibit_style:
           heading: "Exhibit style"
-          searchable:
-            label: "Searchable (offer searchbox and facet sidebar)"
         main_navigation:
           menu: Main menu
-          help: Select the menu items you want to be displayed in the main navigation menu (menu items are only displayed when published pages exist for that item). Click a menu item to change its display label. Drag and drop a menu item to change their order in the menu.
+          help: >
+            Select the menu items you want to be displayed in the main navigation menu
+            (menu items are only displayed when published pages exist for that item).
+            Click a menu item to change its display label. Drag and drop a menu item
+            to change their order in the menu.
         restore_default: "Restore default"
-        search_results: Search results
         site_masthead:
           heading: Site masthead
-          help: "You can select and crop an image to use as a background in your exhibit site's masthead. To use an image as a masthead background, you should use an image that is at least 120 pixels tall and 1200 pixels wide. For best results use an image at least 1800 pixels wide. You can crop larger images using the cropping tool below."
+          help: >
+            You can select and crop an image to use as a background in your exhibit site's
+            masthead. To use an image as a masthead background, you should use an image that
+            is at least 120 pixels tall and 1200 pixels wide. For best results use an image at
+            least 1800 pixels wide. You can crop larger images using the cropping tool below.
         site_thumbnail:
           heading: Site thumbnail
           help: "You can select and crop an image to visually represent this exhibit."
@@ -153,22 +151,57 @@ en:
         browse: Browse
         feature_pages: Feature pages
         about_pages: About pages
+        search_configuration: Search
       nav:
         home: "Home"
       header: "Curation"
-    blacklight_configurations:
-      edit_facet_fields:
-        header: "Search Facets"
-        options: "Options"
-        field:
-          label: "Display Label"
-        items_count:
+    search_configurations:
+      edit:
+        header: "Search"
+        tab:
+          options: "Options"
+          facets: "Facets"
+          results: "Results"
+      search_fields:
+        header: "Field-based search"
+        help: >
+          Enable field-based search to add a dropdown menu to your exhibit sites search box that
+          provides the user with an option to restrict a search query to a single metadata field.
+        instructions: >
+          If enabled, you can select the metadata fields that are available for searching. Click
+          a field name to edit its display label.  Drag and drop fields to specify the order they
+          are displayed in the search box dropdown menu.
+        enable_feature: Enable field-based search
+      facets:
+        help: >
+          If the sidebar is visible, users can use
+          the facets shown in the sidebar to limit a search.  You can select the facets
+          that are available for searching below. Click a facet field name to edit its display label.
+          Drag and drop facets to specify the order they are displayed in the sidebar.
+        document_count:
           one: "%{count} item"
           other:  "%{count} items"
-        values_count:
+        value_count:
           one: "%{count} unique value"
           other: "%{count} unique values"
-      edit_metadata_fields:
+      sort:
+        header: "Sort fields"
+        help: >
+          Select the fields you want to be available to users for sorting results.
+          Click a field title to change its display label. Drag and drop fields to
+          change their order in the sort dropdown menu. The field listed first is
+          the default sort field.
+        keys:
+          asc: ascending
+          desc: descending
+          score: relevancy score
+          sort_date_dtsi: date
+          sort_title_ssi: title
+          sort_type_ssi: type
+          sort_source_ssi: source
+          id: id
+    metadata_configurations:
+      edit:
         field:
           label: "Field name"
         deselect_all: "Deselect all"
@@ -181,24 +214,16 @@ en:
             "You can add metadata fields to supplement the metadata fields that are part of the repository item record."
         view:
           show: "Item Details"
-        instructions: Select metadata fields to display on each type of page. Click a field name to edit its display label. Drag and drop fields to specify the order they are displayed on the Item Details page.
-      edit_sort_fields:
-        header: Sort fields
-        help: "Select the fields you want to be available to users for sorting results. Click a field title to change its display label. Drag and drop fields to change their order in the sort dropdown menu. The field listed first is the default sort field."
-        sort_keys:
-          asc: ascending
-          desc: descending
-          score: relevancy score
-          sort_date_dtsi: date
-          sort_title_ssi: title
-          sort_type_ssi: type
-          sort_source_ssi: source
-          id: id
+        instructions: >
+          Select metadata fields to display on each type of page. Click a field name
+          to edit its display label. Drag and drop fields to specify the order they
+          are displayed on the Item Details page.
     catalog:
       breadcrumb:
         index: 'Search Results'
       edit_default:
-        blank_field_warning_html: "This field is currently hidden on all pages. You can make it visible on the Curation > %{link} page."
+        blank_field_warning_html: >
+          This field is currently hidden on all pages. You can make it visible on the Curation > %{link} page.
         full_title_tesim: "Title"
         url-field:
           help: "Valid file types: %{extensions}"
@@ -274,7 +299,9 @@ en:
       breadcrumb: Home
       delete:
         heading: Delete exhibit
-        warning_html: This action is irreversible. Be sure to back up the exhibit settings and content using the %{export_link} feature before proceeding.
+        warning_html: >
+          This action is irreversible. Be sure to back up the exhibit settings and content using
+          the %{export_link} feature before proceeding.
       edit:
         header: Settings
         basic_settings:
@@ -294,7 +321,9 @@ en:
         button: Import data
       export:
         heading: Export data
-        instructions: You can create a backup of this exhibit by exporting the data that defines it to a JSON file. You can then import that JSON file into new exhibit to restore the exhibit data or to use as a starting point for a new exhibit.
+        instructions: >
+          You can create a backup of this exhibit by exporting the data that defines it to a JSON file.
+          You can then import that JSON file into new exhibit to restore the exhibit data or to use as a starting point for a new exhibit.
         download: Export data
       confirmation_status:
         confirmed: Confirmed.
@@ -334,7 +363,9 @@ en:
         page_options: "Options"
         page_thumbnail: "Thumbnail"
         thumbnail:
-          help: "You can select and crop an image to visually represent this page. It will be used as the thumbnail image if you include this page using the 'Highlight Featured Pages' widget."
+          help: >
+            You can select and crop an image to visually represent this page. It will be
+            used as the thumbnail image if you include this page using the 'Highlight Featured Pages' widget.
     contacts:
       edit:
         header: "Edit Contact"
@@ -356,7 +387,10 @@ en:
         header: Contacts
         contact:
           legend: Contact Details
-        instructions: Enter details for each librarian, curator or other contact person for this exhibit. Select the contacts you want to be show in the sidebar of the About Pages. Drag and drop contacts to specify the order in which they are shown in the sidebar.
+        instructions: >
+          Enter details for each librarian, curator or other contact person for this exhibit.
+          Select the contacts you want to be show in the sidebar of the About Pages. Drag and
+          drop contacts to specify the order in which they are shown in the sidebar.
       nav_link: About
       page_options:
         published: "Publish" # Possibly no longer used
@@ -378,7 +412,9 @@ en:
           remote:
             label: "Upload an image"
             header: "Cropped image"
-            help: 'Adjust the cropping box to cover the area of the image you want to use as the thumbnail image. Click "Save Changes" to save the cropped area.'
+            help: >
+              Adjust the cropping box to cover the area of the image you want to use
+              as the thumbnail image. Click "Save Changes" to save the cropped area.
 
     resources:
       new:
@@ -386,10 +422,6 @@ en:
       form:
         needs_provider: "Could not find an appropriate importer"
         has_provider: "Ready to import"
-      csv:
-        header: 'CSV Import'
-        form:
-          template: "Download Template"
       upload:
         csv:
           success: "'%{file_name}' has been uploaded.  An email will be sent to you once indexing is complete."
@@ -427,9 +459,17 @@ en:
         header: "Browse"
         title: "Curation - Browse"
         categories_header: "Browse Categories"
-        instructions: "Use the Save search button on a search results page to create a new browse category. Select the categories you want to be displayed on the browse landing page. Drag and drop categories to change the order in which they appear on that page."
-        no_saved_searches: "You can save search results while in curation mode to create browse categories, which will be displayed here."
-        not_searchable_html: "This exhibit is not currently searchable. To perform searches that can be saved as additional browse categories, an Administrator must temporarily turn on the Searchable option in the exhibit style section of the Administration > %{href} page."
+        instructions: >
+          Use the Save search button on a search results page to create a new browse category.
+          Select the categories you want to be displayed on the browse landing page. Drag and
+          drop categories to change the order in which they appear on that page."
+        no_saved_searches: >
+          You can save search results while in curation mode to create browse categories,
+          which will be displayed here.
+        not_searchable_html: >
+          This exhibit is not currently searchable. To perform searches that can be saved as
+          additional browse categories, an Administrator must temporarily turn on the Searchable
+          option in the search configuration section of the Administration > %{href} page.
       edit:
         header: "Edit Browse Category"
         title: "Curation - Browse"
@@ -444,8 +484,13 @@ en:
         search_masthead: "Masthead"
         search_thumbnail: "Thumbnail"
         masthead:
-          help: "You can select and crop an image to use as a browse category-specific masthead, instead of the default site masthead, for this browse category's detail page."
-          help_secondary: "To create a browse category-specific masthead, you should use an image that is at least 120 pixels tall and 1200 pixels wide. For best results use an image at least 1800 pixels wide. You can crop larger images using the cropping tool below."
+          help: >
+            You can select and crop an image to use as a browse category-specific masthead, instead
+            of the default site masthead, for this browse category's detail page.
+          help_secondary: >
+            To create a browse category-specific masthead, you should use an image that is at least
+            120 pixels tall and 1200 pixels wide. For best results use an image at least 1800 pixels wide.
+            You can crop larger images using the cropping tool below.
         thumbnail:
           help: "You can select and crop an image to visually represent this search."
     browse:

data/config/routes.rb

@@ -1,6 +1,5 @@
 Spotlight::Engine.routes.draw do
-
-  devise_for :contact_email, class_name: "Spotlight::ContactEmail", only: [:confirmations]
+  devise_for :contact_email, class_name: 'Spotlight::ContactEmail', only: [:confirmations]
 
   resources :exhibits, path: '/', except: [:index, :show] do
     member do
@@ -11,16 +10,14 @@ Spotlight::Engine.routes.draw do
     end
 
     resources :attachments, only: :create
-    resource :contact_form, path: "contact", only: [:new, :create]
+    resource :contact_form, path: 'contact', only: [:new, :create]
     resource :blacklight_configuration, only: [:update]
 
     resource :appearance, only: [:edit, :update]
 
-    get 'edit/metadata', to: "blacklight_configurations#edit_metadata_fields"
-    get 'edit/facets', to: "blacklight_configurations#edit_facet_fields"
-    get 'edit/sort_fields', to: "blacklight_configurations#edit_sort_fields"
-    get 'metadata', to: 'blacklight_configurations#metadata_fields'
-    get 'available_search_views', to: 'blacklight_configurations#available_search_views'
+    resource :metadata_configuration, only: [:show, :edit, :update]
+    resource :search_configuration, only: [:show, :edit, :update]
+    resource :view_configuration, only: [:show]
 
     blacklight_for :catalog, only: [:export]
 
@@ -30,13 +27,13 @@ Spotlight::Engine.routes.draw do
         get 'autocomplete'
       end
 
-      get "facet/:id", :to => "catalog#facet", :as => "catalog_facet"
+      get 'facet/:id', to: 'catalog#facet', as: 'catalog_facet'
 
-      put 'visiblity', to: "catalog#make_public"
-      delete 'visiblity', to: "catalog#make_private"
+      put 'visiblity', to: 'catalog#make_public'
+      delete 'visiblity', to: 'catalog#make_private'
     end
 
-    get "catalog/:id", to: "catalog#show", as: "solr_document"
+    get 'catalog/:id', to: 'catalog#show', as: 'solr_document'
 
     resources :solr_document, only: [:edit], to: 'catalog#edit'
 
@@ -50,7 +47,7 @@ Spotlight::Engine.routes.draw do
       end
     end
 
-    post :csv_uploads, to: "resources/upload#csv_upload", path: 'upload_resources/csv_upload', as: :resources_csv_uploads
+    post :csv_uploads, to: 'resources/upload#csv_upload', path: 'upload_resources/csv_upload', as: :resources_csv_uploads
 
     resources :resources_uploads, controller: 'resources/upload', path: 'upload_resources' do
       collection do
@@ -58,12 +55,6 @@ Spotlight::Engine.routes.draw do
       end
     end
 
-    resources :resources_csvs, controller: 'resources/csv', path: 'csv_resources' do
-      collection do
-        get :template
-      end
-    end
-
     resources :searches do
       collection do
         patch :update_all
@@ -88,7 +79,7 @@ Spotlight::Engine.routes.draw do
         patch :update_all
       end
     end
-    resource :home_page, path: 'home', controller: "home_pages"
+    resource :home_page, path: 'home', controller: 'home_pages'
     post '/pages/:id/preview' => 'pages#preview', as: :preview_block
 
     resources :lock, only: [:destroy]

data/db/migrate/20150410180014_add_taggings_counter_cache_to_tags.acts_as_taggable_on_engine.rb

@@ -0,0 +1,15 @@
+# This migration comes from acts_as_taggable_on_engine (originally 3)
+class AddTaggingsCounterCacheToTags < ActiveRecord::Migration
+  def self.up
+    add_column :tags, :taggings_count, :integer, default: 0
+
+    ActsAsTaggableOn::Tag.reset_column_information
+    ActsAsTaggableOn::Tag.find_each do |tag|
+      ActsAsTaggableOn::Tag.reset_counters(tag.id, :taggings)
+    end
+  end
+
+  def self.down
+    remove_column :tags, :taggings_count
+  end
+end

data/db/migrate/20150410180015_add_missing_taggable_index.acts_as_taggable_on_engine.rb

@@ -0,0 +1,10 @@
+# This migration comes from acts_as_taggable_on_engine (originally 4)
+class AddMissingTaggableIndex < ActiveRecord::Migration
+  def self.up
+    add_index :taggings, [:taggable_id, :taggable_type, :context]
+  end
+
+  def self.down
+    remove_index :taggings, [:taggable_id, :taggable_type, :context]
+  end
+end

data/db/migrate/20150410180016_change_collation_for_tag_names.acts_as_taggable_on_engine.rb

@@ -0,0 +1,10 @@
+# This migration comes from acts_as_taggable_on_engine (originally 5)
+# This migration is added to circumvent issue #623 and have special characters
+# work properly
+class ChangeCollationForTagNames < ActiveRecord::Migration
+  def up
+    if ActsAsTaggableOn::Utils.using_mysql?
+      execute("ALTER TABLE tags MODIFY name varchar(255) CHARACTER SET utf8 COLLATE utf8_bin;")
+    end
+  end
+end

data/db/migrate/20150713160101_change_spotlight_searches_to_published.rb

@@ -0,0 +1,5 @@
+class ChangeSpotlightSearchesToPublished < ActiveRecord::Migration
+  def up
+    rename_column :spotlight_searches, :on_landing_page, :published
+  end
+end

data/db/migrate/20151016092343_remove_searchable_from_exhibit.rb

@@ -0,0 +1,20 @@
+class RemoveSearchableFromExhibit < ActiveRecord::Migration
+  def up
+    Spotlight::Exhibit.where(searchable: false).find_each do |e|
+      e.home_page.update(display_sidebar: false)
+    end
+
+    Spotlight::Exhibit.where(searchable: true).find_each do |e|
+      key = e.blacklight_configuration.default_blacklight_config.default_search_field.key
+
+      e.blacklight_configuration.search_fields[key] ||= {}
+      e.blacklight_configuration.search_fields[key][:enabled] = true
+    end
+
+    remove_column :spotlight_exhibits, :searchable
+  end
+
+  def down
+    add_column :spotlight_exhibits, :searchable, :boolean, default: true
+  end
+end

data/lib/blacklight/spotlight.rb

@@ -1 +1 @@
-require 'spotlight'
+require 'spotlight'