blacklight-spotlight 0.4.1 → 0.5.0

data/app/serializers/spotlight/exhibit_export_serializer.rb

@@ -4,43 +4,61 @@ require 'base64'
 require 'tempfile'
 
 module Spotlight
+  ##
+  # Serialize the Spotlight::BlacklightConfiguration
   class ConfigurationRepresenter < Roar::Decorator
     include Roar::JSON
 
-    (Spotlight::BlacklightConfiguration.attribute_names - ['id', 'exhibit_id']).each do |prop|
+    (Spotlight::BlacklightConfiguration.attribute_names - %w(id exhibit_id)).each do |prop|
       property prop
     end
   end
 
+  ##
+  # Serialize an exhibit with all the data needed to reconstruct it
+  # in a different environment
+  # rubocop:disable Metrics/ClassLength
   class ExhibitExportSerializer < Roar::Decorator
     include Roar::JSON
 
-    (Spotlight::Exhibit.attribute_names - ['id', 'default', 'slug']).each do |prop|
+    (Spotlight::Exhibit.attribute_names - %w(id slug)).each do |prop|
       property prop
     end
 
-    collection :searches, parse_strategy: lambda { |fragment, i, options| options.represented.searches.find_or_initialize_by(slug: fragment['slug']) }, class: Spotlight::Search do
-      (Spotlight::Search.attribute_names - ['id', 'exhibit_id']).each do |prop|
+    property :default, setter: ->(val, _args) { self.default = val if val && !Spotlight::Exhibit.default? }
+
+    collection :searches, parse_strategy: ->(fragment, _i, options) { options.represented.searches.find_or_initialize_by(slug: fragment['slug']) },
+                          class: Spotlight::Search do
+      (Spotlight::Search.attribute_names - %w(id exhibit_id)).each do |prop|
         property prop
       end
     end
 
-    collection :about_pages, parse_strategy: lambda { |fragment, i, options| options.represented.about_pages.find_or_initialize_by(slug: fragment['slug']) }, class: Spotlight::AboutPage, decorator: PageRepresenter
+    collection :about_pages, parse_strategy: ->(fragment, _i, options) { options.represented.about_pages.find_or_initialize_by(slug: fragment['slug']) },
+                             class: Spotlight::AboutPage,
+                             decorator: PageRepresenter
 
-    collection :feature_pages, parse_strategy: lambda { |fragment, i, options| options.represented.feature_pages.find_or_initialize_by(slug: fragment['slug']) }, getter: lambda { |opts| feature_pages.at_top_level }, class: Spotlight::FeaturePage, decorator: NestedPageRepresenter
+    collection :feature_pages, parse_strategy: ->(fragment, _i, options) { options.represented.feature_pages.find_or_initialize_by(slug: fragment['slug']) },
+                               getter: ->(_opts) { feature_pages.at_top_level },
+                               class: Spotlight::FeaturePage,
+                               decorator: NestedPageRepresenter
 
-    property :home_page, parse_strategy: lambda { |fragment, options| options.represented.home_page }, class: Spotlight::HomePage, decorator: PageRepresenter
+    property :home_page, parse_strategy: ->(_fragment, options) { options.represented.home_page },
+                         class: Spotlight::HomePage,
+                         decorator: PageRepresenter
 
     property :blacklight_configuration, class: Spotlight::BlacklightConfiguration, decorator: ConfigurationRepresenter
 
-    collection :custom_fields, parse_strategy: lambda { |fragment, i, options| options.represented.custom_fields.find_or_initialize_by(slug: fragment['slug']) }, class: Spotlight::CustomField do
-      (Spotlight::CustomField.attribute_names - ['id', 'exhibit_id']).each do |prop|
+    collection :custom_fields, parse_strategy: ->(fragment, _i, options) { options.represented.custom_fields.find_or_initialize_by(slug: fragment['slug']) },
+                               class: Spotlight::CustomField do
+      (Spotlight::CustomField.attribute_names - %w(id exhibit_id)).each do |prop|
         property prop
       end
     end
 
-    collection :contacts, parse_strategy: lambda { |fragment, i, options| options.represented.contacts.find_or_initialize_by(slug: fragment['slug']) }, class: Spotlight::Contact do
-      (Spotlight::Contact.attribute_names - ['id', 'exhibit_id', 'avatar']).each do |prop|
+    collection :contacts, parse_strategy: ->(fragment, _i, options) { options.represented.contacts.find_or_initialize_by(slug: fragment['slug']) },
+                          class: Spotlight::Contact do
+      (Spotlight::Contact.attribute_names - %w(id exhibit_id avatar)).each do |prop|
         property prop
       end
 
@@ -52,19 +70,21 @@ module Spotlight
         { filename: file.filename, content_type: file.content_type, content: Base64.encode64(file.read) }
       end
 
-      def avatar= file
-        represented.avatar = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file['content'])), filename: file['filename'], content_type: file['content_type']
+      def avatar=(file)
+        represented.avatar = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file['content'])),
+                                                            filename: file['filename'],
+                                                            content_type: file['content_type']
       end
     end
 
     collection :contact_emails, class: Spotlight::ContactEmail do
-      (Spotlight::ContactEmail.attribute_names - ['id', 'exhibit_id']).each do |prop|
+      (Spotlight::ContactEmail.attribute_names - %w(id exhibit_id)).each do |prop|
         property prop
       end
     end
 
     collection :solr_document_sidecars, class: Spotlight::SolrDocumentSidecar do
-      (Spotlight::SolrDocumentSidecar.attribute_names - ['id',  'document_type', 'exhibit_id']).each do |prop|
+      (Spotlight::SolrDocumentSidecar.attribute_names - %w(id document_type exhibit_id)).each do |prop|
         property prop
       end
 
@@ -73,10 +93,8 @@ module Spotlight
       def document_type
         represented.document_type.to_s
       end
-      
-      def document_type= klass
-        represented.document_type = klass
-      end
+
+      delegate :document_type=, to: :represented
     end
 
     collection :owned_taggings, class: ActsAsTaggableOn::Tagging do
@@ -89,13 +107,13 @@ module Spotlight
         represented.tag.name
       end
 
-      def tag= tag
+      def tag=(tag)
         represented.tag = ActsAsTaggableOn::Tag.find_or_create_by name: tag
       end
     end
 
     collection :attachments, class: Spotlight::Attachment do
-      (Spotlight::Attachment.attribute_names - ['id', 'exhibit_id', 'file']).each do |prop|
+      (Spotlight::Attachment.attribute_names - %w(id exhibit_id file)).each do |prop|
         property prop
       end
 
@@ -107,29 +125,47 @@ module Spotlight
         { filename: file.filename, content_type: file.content_type, content: Base64.encode64(file.read) }
       end
 
-      def file= file
-        represented.file = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file['content'])), filename: file['filename'], content_type: file['content_type']
+      def file=(file)
+        represented.file = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file['content'])),
+                                                          filename: file['filename'],
+                                                          content_type: file['content_type']
       end
-
     end
 
-    collection :resources, class: lambda { |fragment,*| fragment.has_key?('type') ? fragment['type'].constantize : Spotlight::Resource } do
-      (Spotlight::Resource.attribute_names - ['id', 'exhibit_id', 'url']).each do |prop|
+    collection :resources, class: ->(fragment, *) { fragment.key?('type') ? fragment['type'].constantize : Spotlight::Resource } do
+      (Spotlight::Resource.attribute_names - %w(id url exhibit_id)).each do |prop|
         property prop
       end
 
+      property :url, exec_context: :decorator
       property :file, exec_context: :decorator
 
+      def url
+        return if represented.is_a? Spotlight::Resources::Upload
+
+        represented.url
+      end
+
+      def url=(url)
+        return if represented.is_a? Spotlight::Resources::Upload
+
+        represented.url = url
+      end
+
       def file
+        return unless represented.is_a? Spotlight::Resources::Upload
         file = represented.url.file
 
         { filename: file.filename, content_type: file.content_type, content: Base64.encode64(file.read) }
       end
 
-      def file= file
-        represented.url = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file['content'])), filename: file['filename'], content_type: file['content_type']
+      def file=(file)
+        return unless represented.is_a? Spotlight::Resources::Upload
+        represented.url = CarrierWave::SanitizedFile.new tempfile: StringIO.new(Base64.decode64(file['content'])),
+                                                         filename: file['filename'],
+                                                         content_type: file['content_type']
       end
-
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/app/serializers/spotlight/page_representer.rb

@@ -1,9 +1,11 @@
 require 'roar/decorator'
 require 'roar/json'
 module Spotlight
+  ##
+  # Serialize an exhibit page
   class PageRepresenter < Roar::Decorator
     include Roar::JSON
-    (Spotlight::Page.attribute_names - ['id', 'scope', 'exhibit_id', 'parent_page_id', 'content']).each do |prop|
+    (Spotlight::Page.attribute_names - %w(id scope exhibit_id parent_page_id content)).each do |prop|
       property prop
     end
 
@@ -14,12 +16,14 @@ module Spotlight
       represented.content.as_json
     end
 
-    def content= content
-      represented.content = content
-    end
+    delegate :content=, to: :represented
   end
 
+  ##
+  # Serialize the page hierarchy (e.g. for Feature pages)
   class NestedPageRepresenter < PageRepresenter
-    collection :child_pages, parse_strategy: lambda { |fragment, i, options| options.represented.child_pages.find_or_initialize_by(slug: fragment['slug']) }, class: Spotlight::FeaturePage, extend: NestedPageRepresenter
+    collection :child_pages, parse_strategy: ->(fragment, _i, options) { options.represented.child_pages.find_or_initialize_by(slug: fragment['slug']) },
+                             class: Spotlight::FeaturePage,
+                             extend: NestedPageRepresenter
   end
-end
+end

data/app/uploaders/spotlight/attachment_uploader.rb

@@ -1,7 +1,8 @@
 # encoding: utf-8
 module Spotlight
+  ##
+  # Sir-trevor image widget uploads
   class AttachmentUploader < CarrierWave::Uploader::Base
-
     # Include RMagick or MiniMagick support:
     # include CarrierWave::RMagick
     include CarrierWave::MiniMagick
@@ -14,19 +15,17 @@ module Spotlight
       "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
     end
 
-
     version :large do
       process resize_to_limit: [850, nil]
     end
- 
+
     version :medium do
       process resize_to_limit: [640, nil]
     end
- 
+
     version :small do
       process resize_to_limit: [320, nil]
     end
- 
 
     # Provide a default URL as a default if there hasn't been a file uploaded:
     # def default_url
@@ -59,6 +58,5 @@ module Spotlight
     # def filename
     #   "something.jpg" if original_filename
     # end
-
   end
 end

data/app/uploaders/spotlight/avatar_uploader.rb

@@ -1,12 +1,14 @@
 module Spotlight
+  ##
+  # Exhibit contact profile pictures
   class AvatarUploader < CarrierWave::Uploader::Base
     include CarrierWave::MiniMagick
 
     storage Spotlight::Engine.config.uploader_storage
 
     version :thumb do
-      process crop: :avatar  ## Crops this version based on original image
-      resize_to_limit(70,70)
+      process crop: :avatar ## Crops this version based on original image
+      resize_to_limit(70, 70)
     end
 
     # Override the directory where uploaded files will be stored.
@@ -14,6 +16,5 @@ module Spotlight
     def store_dir
       "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
     end
-
   end
 end

data/app/uploaders/spotlight/featured_image_uploader.rb

@@ -1,20 +1,21 @@
-# encoding: utf-8
+module Spotlight
+  ##
+  # Page, browse category, and exhibit featured image thumbnails
+  class FeaturedImageUploader < CarrierWave::Uploader::Base
+    include CarrierWave::MiniMagick
 
-class Spotlight::FeaturedImageUploader < CarrierWave::Uploader::Base
-  include CarrierWave::MiniMagick
+    storage Spotlight::Engine.config.uploader_storage
 
-  storage Spotlight::Engine.config.uploader_storage
-  
-  version :cropped do
-    process crop: :image  ## Crops this version based on original image
-  end
+    version :cropped do
+      process crop: :image ## Crops this version based on original image
+    end
 
-  version :thumb, from_version: :cropped do
-    process resize_to_fill: [400, 300]
-  end
+    version :thumb, from_version: :cropped do
+      process resize_to_fill: [400, 300]
+    end
 
-  def store_dir
-    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+    def store_dir
+      "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+    end
   end
-
 end

data/app/uploaders/spotlight/item_uploader.rb

@@ -1,5 +1,8 @@
 # encoding: utf-8
 module Spotlight
+  ##
+  # Uploaded resource image attachments, downloaded locally for cropping and
+  # representation. See {Spotlight::Resource::Upload}
   class ItemUploader < CarrierWave::Uploader::Base
     include CarrierWave::MiniMagick
     extend Spotlight::ImageDerivatives
@@ -14,6 +17,5 @@ module Spotlight
     def store_dir
       "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
     end
-
   end
 end

data/app/uploaders/spotlight/masthead_uploader.rb

@@ -1,12 +1,14 @@
 # encoding: utf-8
 module Spotlight
+  ##
+  # Exhibit and browse category custom mastheads
   class MastheadUploader < CarrierWave::Uploader::Base
     include CarrierWave::MiniMagick
     storage Spotlight::Engine.config.uploader_storage
 
     version :cropped do
-      process crop: :image  ## Crops this version based on original image
-      process resize_to_fill: [1800, 120]
+      process crop: :image ## Crops this version based on original image
+      process resize_to_fill: [1800, 180]
     end
 
     def store_dir

data/app/views/catalog/_search_form.html.erb

@@ -0,0 +1,24 @@
+<%= form_tag search_action_url, method: :get, class: 'search-query-form clearfix navbar-form', role: 'search' do %>
+  <%= render_hash_as_hidden_fields(params_for_search().except(:q, :search_field, :qt, :page, :utf8)) %>
+
+  <div class="input-group">
+    <% if search_fields.length > 1 %>
+      <span class="input-group-addon for-search-field">
+        <label for="search_field" class="sr-only"><%= t('blacklight.search.form.search_field.label') %></label>
+        <%= select_tag(:search_field, options_for_select(search_fields, h(params[:search_field])), title: t('blacklight.search.form.search_field.title'), id: "search_field", class: "search_field") %>
+      </span>
+    <% elsif search_fields.length == 1 %>
+      <%= hidden_field_tag :search_field, search_fields.first.last %>
+    <% end %>
+
+    <label for="q" class="sr-only"><%= t('blacklight.search.form.search.label') %></label>
+    <%= text_field_tag :q, params[:q], placeholder: t('blacklight.search.form.search.placeholder'), class: "search_q q form-control", id: "q", autofocus: should_autofocus_on_search_box?  %>
+
+    <span class="input-group-btn">
+      <button type="submit" class="btn btn-primary search-btn" id="search">
+        <span class="submit-search-text"><%= t('blacklight.search.form.submit') %></span>
+        <span class="glyphicon glyphicon-search"></span>
+      </button>
+    </span>
+  </div>
+<% end %>

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

@@ -1,3 +1,3 @@
-<% if current_exhibit.has_browse_categories? %>
+<% if current_exhibit.browse_categories? %>
   <li class="<%= "active" if on_browse_page? %>"><%= link_to navigation.label_or_default, spotlight.exhibit_browse_index_path(current_exhibit) %></li>
 <% end %>

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

@@ -12,7 +12,7 @@
       <% end %>
     </ul>
     <% if should_render_spotlight_search_bar? %>
-      <div class="navbar-right col-sm-4 col-md-4">
+      <div class="navbar-right navbar-nav nav">
         <%= render_search_bar  %>
       </div>
     <% end %>

data/app/views/spotlight/appearances/edit.html.erb

@@ -2,13 +2,13 @@
 <div id="content" class="col-md-9">
   <%= administration_page_title %>
 
-<%= bootstrap_form_for @appearance, url: spotlight.exhibit_appearance_path(@exhibit), layout: :horizontal, label_col: 'col-md-3', control_col: 'col-sm-5', html: {data: { autocomplete_exhibit_catalog_index_path: spotlight.autocomplete_exhibit_catalog_index_path(current_exhibit, q: "%QUERY", format: "json") } } do |f| %>
-  <% if @appearance.errors.any? %>
+<%= bootstrap_form_for @exhibit, url: spotlight.exhibit_appearance_path(@exhibit), layout: :horizontal, label_col: 'col-md-3', control_col: 'col-sm-5', html: {data: { autocomplete_exhibit_catalog_index_path: spotlight.autocomplete_exhibit_catalog_index_path(current_exhibit, q: "%QUERY", format: "json") } } do |f| %>
+  <% if @exhibit.errors.any? %>
     <div id="error_explanation">
-      <h2><%= pluralize(@appearance.errors.count, "error") %> prohibited this page from being saved:</h2>
+      <h2><%= pluralize(@exhibit.errors.count, "error") %> prohibited this page from being saved:</h2>
 
       <ul>
-      <% @appearance.errors.full_messages.each do |msg| %>
+      <% @exhibit.errors.full_messages.each do |msg| %>
         <li><%= msg %></li>
       <% end %>
       </ul>
@@ -17,30 +17,19 @@
   <div role="tabpanel">
     <ul class="nav nav-tabs" role="tablist">
       <li role="presentation" class="active">
-        <a href="#style" area-controls="style" role="tab" data-toggle="tab"><%= t(:'.exhibit_style.heading') %></a>
-      </li>
-      <li role="presentation">
-        <a href="#site-masthead" area-controls="site-masthead" role="tab" data-toggle="tab"><%= t(:'.site_masthead.heading') %></a>
+        <a href="#site-masthead" aria-controls="site-masthead" role="tab" data-toggle="tab"><%= t(:'.site_masthead.heading') %></a>
       </li>
       
       <li role="presentation">
-        <a href="#site-thumbnail" area-controls="site-thumbnail" role="tab" data-toggle="tab"><%= t(:'.site_thumbnail.heading') %></a>
+        <a href="#site-thumbnail" aria-controls="site-thumbnail" role="tab" data-toggle="tab"><%= t(:'.site_thumbnail.heading') %></a>
       </li>
 
       <li role="presentation">
-        <a href="#main-menu" area-controls="main-menu" role="tab" data-toggle="tab"><%= t(:'.main_navigation.menu') %></a>
-      </li>
-      <li role="presentation">
-        <a href="#search-results" area-controls="search-results" role="tab" data-toggle="tab"><%= t(:'.search_results') %></a>
+        <a href="#main-menu" aria-controls="main-menu" role="tab" data-toggle="tab"><%= t(:'.main_navigation.menu') %></a>
       </li>
     </ul>
     <div class="tab-content">
-      <div role="tabpanel" class="tab-pane active" id="style">
-        <%= field_set_tag do %>
-          <%= f.check_box(:searchable, label: t(:'.exhibit_style.searchable.label')) %>
-        <% end %>
-      </div>
-      <div role="tabpanel" class="tab-pane" id="site-masthead">
+      <div role="tabpanel" class="tab-pane active" id="site-masthead">
         <p class="instructions"><%= t(:'.site_masthead.help') %></p>
         <%= f.fields_for(:masthead, current_exhibit.masthead || current_exhibit.build_masthead) do |m| %>
           <%= render '/spotlight/featured_images/form', f: m, jcrop_options: default_masthead_jcrop_options %>
@@ -59,10 +48,8 @@
           <p class="instructions"><%= t(:'.main_navigation.help') %></p>
           <div class="panel-group dd main_navigation_admin col-sm-7" id="nested-navigation" data-behavior="nestable" data-max-depth="1">
             <ol class="dd-list">
-              <%= f.fields_for :main_navigations do |navigation| %>
-                <%  @appearance.main_navigations.each do |nav| %>
-                  <%= navigation.fields_for nav.id.to_s, nav do |label| %>
-                    <li class="dd-item dd3-item" data-id="<%= nav.id %>">
+              <%= f.fields_for :main_navigations do |label| %>
+                    <li class="dd-item dd3-item" data-id="<%= label.object.id %>">
                       <div class="dd3-content panel panel-default">
                         <div class="dd-handle dd3-handle"><%= t :drag %></div>
                         <div class="panel-heading" data-behavior="restore-default">
@@ -74,43 +61,24 @@
                               </div>
                               <div class="main">
                                 <h3 class="panel-title" data-in-place-edit-target=".edit-in-place" data-in-place-edit-field-target="[data-edit-field-target='true']">
-                                  <a href="#edit-in-place" class="field-label edit-in-place"><%= nav.label_or_default %></a>
-                                  <%= label.hidden_field :label, data: {:"default-value" => nav.default_label, :"edit-field-target" => 'true'} %>
+                                  <a href="#edit-in-place" class="field-label edit-in-place"><%= label.object.label_or_default %></a>
+                                  <%= label.hidden_field :label, data: {:"default-value" => label.object.default_label, :"edit-field-target" => 'true'} %>
                                 </h3>
                               </div>
                             </div>
                             <div class="col-sm-4">
-                              <%= button_tag t(:'.restore_default'), data: {:"restore-default" => true}, class: "btn restore-default btn-default btn-sm pull-right #{'hidden' if nav.label.blank? || nav.label == nav.default_label}" %>
+                              <%= button_tag t(:'.restore_default'), data: {:"restore-default" => true}, class: "btn restore-default btn-default btn-sm pull-right #{'hidden' if label.object.label.blank? || label.object.label == label.object.default_label}" %>
                             </div>
                           </div>
                           <%= label.hidden_field :weight, data: {property: "weight"} %>
                         </div>
                       </div>
                     </li>
-                  <% end %>
-                <% end %>
               <% end %>
             </ol>
           </div>
         <% end %>
       </div>
-      <div role="tabpanel" class="tab-pane" id="search-results">
-        <%= field_set_tag do %>
-          <%= f.form_group :document_index_view_types, label: {text: t(:'.document_index_view_types')} do %>
-            <%= f.fields_for :document_index_view_types, @appearance.document_index_view_types do |vt| %>
-              <% @appearance.view_type_options.each do |key| %>
-                <%= vt.check_box key %>
-              <% end %>
-            <% end %>
-          <% end %>
-
-          <%= f.form_group :default_per_page, label: { text: t(:'.default_per_page')} do %>
-            <% @appearance.per_page_options.each do |key| %>
-              <%= f.radio_button :default_per_page, key, label: key.to_s %>
-            <% end %>
-          <% end %>
-        <% end %>
-      </div>
     </div>
   </div>