blacklight-spotlight 0.2.0 → 0.3.0

data/app/models/spotlight/search.rb

@@ -9,6 +9,7 @@ class Spotlight::Search < ActiveRecord::Base
   default_scope { order("weight ASC") }
   scope :published, -> { where(on_landing_page: true) }
   validates :title, presence: true
+  has_paper_trail
 
   before_create do
     self.featured_item_id ||= default_featured_item_id
@@ -40,7 +41,7 @@ class Spotlight::Search < ActiveRecord::Base
       facet: false)
 
     Blacklight::SolrResponse.new(response, {}).docs.map do |result|
-      doc = ::SolrDocument.new(result)
+      doc = blacklight_config.solr_document_model.new(result)
 
       [
         doc.first(blacklight_config.solr_document_model.unique_key),
@@ -50,18 +51,23 @@ class Spotlight::Search < ActiveRecord::Base
     end
   end
 
+  def as_json(*args)
+    super.merge(featured_image: featured_image, count: count)
+  end
+
   def default_featured_item_id
     images.first.first if images.present?
   end
 
+  def blacklight_config
+    exhibit.blacklight_config
+  end
+
   private
   def should_generate_new_friendly_id?
     title_changed?
   end
 
-  def blacklight_config
-    exhibit.blacklight_config
-  end
   
   alias_method :current_exhibit, :exhibit
 

data/app/models/spotlight/solr_document_sidecar.rb

@@ -1,13 +1,13 @@
 module Spotlight
   class SolrDocumentSidecar < ActiveRecord::Base
     belongs_to :exhibit
-    belongs_to :solr_document
+    belongs_to :document, polymorphic: true
     serialize :data, Hash
 
     delegate :has_key?, to: :data
 
     def to_solr
-      { blacklight_config.solr_document_model.unique_key.to_sym => solr_document_id, visibility_field => public? }.merge(data_to_solr)
+      { document.class.unique_key.to_sym => document.id, visibility_field => public? }.merge(data_to_solr)
     end
 
     def private!
@@ -18,6 +18,19 @@ module Spotlight
       update public: true
     end
 
+    # Roll our own polymorphism because our documents are not AREL-able
+    def document
+      document_type.new document_type.unique_key => document_id
+    end
+
+    def document_type
+      (super.constantize if defined?(super)) || default_document_type
+    end
+
+    def default_document_type
+      blacklight_config.solr_document_model
+    end
+
     protected
 
     def visibility_field

data/app/serializers/spotlight/exhibit_export_serializer.rb

@@ -1,67 +1,135 @@
+require 'roar/decorator'
+require 'roar/json'
+require 'base64'
+require 'tempfile'
+
 module Spotlight
+  class ConfigurationRepresenter < Roar::Decorator
+    include Roar::JSON
 
-  def self.ExportSerializer klass
-    return Class.new(ExportSerializer) do
-      attributes *(klass.attribute_names.map { |x| x.to_sym })
+    (Spotlight::BlacklightConfiguration.attribute_names - ['id', 'exhibit_id']).each do |prop|
+      property prop
     end
-
   end
 
-  class ExportSerializer < ActiveModel::Serializer
-    def filter keys
-      keys = keys.reject { |k| k.to_s =~ /id$/ }
-      keys = keys - [:scope]
+  class ExhibitExportSerializer < Roar::Decorator
+    include Roar::JSON
+
+    (Spotlight::Exhibit.attribute_names - ['id', 'default', 'slug']).each do |prop|
+      property prop
     end
-  end
 
-  class PageExportSerializer  < Spotlight::ExportSerializer(Spotlight::Page)
-    has_many :child_pages, root: 'child_pages_attributes', serializer: PageExportSerializer
-  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 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 :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
+
+    property :home_page, parse_strategy: lambda { |fragment, options| options.represented.home_page }, class: Spotlight::HomePage, decorator: PageRepresenter
 
-  class SolrDocumentSerializer < Spotlight::ExportSerializer(Spotlight::SolrDocumentSidecar)
-    def filter keys
-      keys = super
-      keys += [:solr_document_id]
+    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|
+        property prop
+      end
     end
-  end
 
-  class TaggingSerializer < Spotlight::ExportSerializer(ActsAsTaggableOn::Tagging)
-    has_one :tag, root: 'tag_attributes', serializer: Spotlight.ExportSerializer(ActsAsTaggableOn::Tag)
-    def filter keys
-      keys = super
-      keys -= [:tagger_type]
-      keys -= [:context] # context conflicts with ActiveRecord methods; fortunately, we only have the default context
-      keys += [:taggable_id]
+    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|
+        property prop
+      end
+
+      property :avatar, exec_context: :decorator
+
+      def avatar
+        file = represented.avatar.file
+
+        { 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']
+      end
+    end
+
+    collection :contact_emails, class: Spotlight::ContactEmail do
+      (Spotlight::ContactEmail.attribute_names - ['id', 'exhibit_id']).each do |prop|
+        property prop
+      end
     end
-  end
 
-  class ExhibitExportSerializer < Spotlight::ExportSerializer(Spotlight::Exhibit)
-    self.root = false
+    collection :solr_document_sidecars, class: Spotlight::SolrDocumentSidecar do
+      (Spotlight::SolrDocumentSidecar.attribute_names - ['id',  'document_type', 'exhibit_id']).each do |prop|
+        property prop
+      end
 
-    def filter  keys
-      keys = super
-      keys = keys - [:slug, :name, :default]
+      property :document_type, exec_context: :decorator
+
+      def document_type
+        represented.document_type.to_s
+      end
+      
+      def document_type= klass
+        represented.document_type = klass
+      end
     end
 
-    def feature_pages
-      object.feature_pages.at_top_level
+    collection :owned_taggings, class: ActsAsTaggableOn::Tagging do
+      property :taggable_id
+      property :taggable_type
+      property :context
+      property :tag, exec_context: :decorator
+
+      def tag
+        represented.tag.name
+      end
+
+      def tag= tag
+        represented.tag = ActsAsTaggableOn::Tag.find_or_create_by name: tag
+      end
     end
 
-    has_many :searches, root: 'searches_attributes', serializer: Spotlight.ExportSerializer(Spotlight::Search)
-    has_one :home_page, root: 'home_page_attributes', serializer:  Spotlight.ExportSerializer(Spotlight::Page)
-    has_many :about_pages, root: 'about_pages_attributes', serializer:  Spotlight.ExportSerializer(Spotlight::Page)
-    has_many :feature_pages, root: 'feature_pages_attributes', serializer:  Spotlight::PageExportSerializer
-    has_many :custom_fields, root: 'custom_fields_attributes', serializer: Spotlight.ExportSerializer(Spotlight::CustomField)
-    has_many :contacts, root: 'contacts_attributes', serializer: Spotlight.ExportSerializer(Spotlight::Contact)
-    has_many :contact_emails, root: 'contact_emails_attributes', serializer: Spotlight.ExportSerializer(Spotlight::ContactEmail)
-    has_one :blacklight_configuration, root: 'blacklight_configuration_attributes', serializer: Spotlight.ExportSerializer(Spotlight::BlacklightConfiguration)
-    
-    has_many :solr_document_sidecars, root: 'solr_document_sidecars_attributes', serializer: Spotlight::SolrDocumentSerializer
-    has_many :owned_taggings, root: 'owned_taggings_attributes', serializer: Spotlight::TaggingSerializer
-    # todo: include attachment binary paylod??
-    has_many :attachments, root: 'attachments_attributes', serializer: Spotlight.ExportSerializer(Spotlight::Attachment)
-
-    has_many :resources, root: 'resources_attributes', serializer: Spotlight.ExportSerializer(Spotlight::Resource)
-  end
+    collection :attachments, class: Spotlight::Attachment do
+      (Spotlight::Attachment.attribute_names - ['id', 'exhibit_id', 'file']).each do |prop|
+        property prop
+      end
+
+      property :file, exec_context: :decorator
 
+      def file
+        file = represented.file.file
+
+        { 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']
+      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|
+        property prop
+      end
+
+      property :file, exec_context: :decorator
+
+      def file
+        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']
+      end
+
+    end
+  end
 end

data/app/serializers/spotlight/page_representer.rb

@@ -0,0 +1,25 @@
+require 'roar/decorator'
+require 'roar/json'
+module Spotlight
+  class PageRepresenter < Roar::Decorator
+    include Roar::JSON
+    (Spotlight::Page.attribute_names - ['id', 'scope', 'exhibit_id', 'parent_page_id', 'content']).each do |prop|
+      property prop
+    end
+
+    property :content, exec_context: :decorator
+
+    def content
+      # get the sir-trevor objects as JSON.
+      represented.content.as_json
+    end
+
+    def content= content
+      represented.content = content
+    end
+  end
+
+  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
+  end
+end

data/app/uploaders/spotlight/avatar_uploader.rb

@@ -8,5 +8,12 @@ module Spotlight
       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.
+    # This is a sensible default for uploaders that are meant to be mounted:
+    def store_dir
+      "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+    end
+
   end
 end

data/app/uploaders/spotlight/featured_image_uploader.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+class Spotlight::FeaturedImageUploader < CarrierWave::Uploader::Base
+
+  storage :file
+
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+end

data/app/uploaders/spotlight/item_uploader.rb

@@ -2,10 +2,10 @@
 module Spotlight
   class ItemUploader < CarrierWave::Uploader::Base
     include CarrierWave::MiniMagick
-    extend Spotlight::ConfigurableUploaderVersions
+    extend Spotlight::ImageDerivatives
     storage :file
 
-    apply_spotlight_versions
+    apply_spotlight_image_derivative_versions
 
     def extension_white_list
       Spotlight::Engine.config.allowed_upload_extensions

data/app/uploaders/spotlight/masthead_uploader.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+module Spotlight
+  class MastheadUploader < CarrierWave::Uploader::Base
+    include CarrierWave::MiniMagick
+    storage :file
+
+    version :cropped_masthead do
+      process crop: :image  ## Crops this version based on original image
+      process resize_to_fill: [1800, 120]
+    end
+
+    def store_dir
+      "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-<%= button_tag t(:'spotlight.saved_search.label'), class: 'btn btn-default',  data: {toggle:"modal", target:"#save-modal"} %>
+<%= button_tag t(:'spotlight.saved_search.label'), id: "save-this-search", class: 'btn btn-default',  data: {toggle:"modal", target:"#save-modal"} %>
 <div class="modal fade" id="save-modal" tabindex="-1" role="dialog" aria-labelledby="save-modal-label" aria-hidden="true">
   <div class="modal-dialog">
   <%= bootstrap_form_for [spotlight, current_exhibit, Spotlight::Search.new] do |f| %>
@@ -18,4 +18,4 @@
     </div>
     <% end %>
   </div>
-</div>
+</div>

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

@@ -18,7 +18,10 @@
     <%= stylesheet_link_tag    "application" %>
     <%= javascript_include_tag "application" %>
     <%= csrf_meta_tags %>
-    <%= content_for(:head) %> 
+    <%= content_for(:head) %>
+    <%= description %>
+    <%= twitter_card %>
+    <%= opengraph %>
 
     <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
     <!--[if lt IE 9]>

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

@@ -0,0 +1,12 @@
+<% if Spotlight::Engine.config.ga_web_property_id %>
+<script>
+(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ga('create', <%= Spotlight::Engine.config.ga_web_property_id.to_json %>, 'auto');
+ga('send', 'pageview');
+
+</script>
+<% end %>

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

@@ -1,5 +1,9 @@
 <%= cache [current_exhibit,cache_key_for_spotlight_exhibits] do %>
-<div id="exhibit-masthead" class="jumbotron">
+<div id="exhibit-masthead" class="jumbotron <%= 'with-image' if current_exhibit.masthead.try(:display?) %>">
+  <% if current_exhibit.masthead.try(:display?) %>
+    <span class='background-container' style="background-image: url('<%= current_exhibit.masthead.image.cropped_masthead %>')"></span>
+    <span class='background-container-gradient'></span>
+  <% end %>
   <div class="container">
     <ul class="more-exhibits nav navbar-nav navbar-sm">
       <% if Spotlight::Exhibit.many? %>

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

@@ -4,3 +4,4 @@
   </div>
 </footer>
 
+<%= render 'shared/analytics' %>

data/app/views/spotlight/about_pages/_contacts_form.html.erb

@@ -0,0 +1,19 @@
+<%= bootstrap_form_for @exhibit, url: exhibit_contacts_path(@exhibit),
+    style: :horizontal, html: {class: 'exhibit-contacts'} do |f| %>
+  <h3><%= t :".header" %></h3>
+  <p class="instructions"><%= t :'.instructions' %></p>
+  <div class="panel-group dd contacts_admin" data-behavior="nestable" data-max-depth="1">
+    <ol class="dd-list">
+      <%= f.fields_for :contacts do |c| %>
+        <%= render partial: 'contact', locals: {f: c} %>
+      <% end %>
+    </ol>
+  </div>
+  <div class="form-actions" style="margin-top: 1em;">
+
+    <%= exhibit_create_link Spotlight::Contact.new, class: "btn btn-primary" %>
+    <div class="primary-actions">
+      <%= f.submit nil, class: 'btn btn-primary' %>
+    </div>
+  </div>
+<% end %>

data/app/views/spotlight/about_pages/index.html.erb

@@ -1,23 +1,7 @@
 <%= render 'spotlight/shared/curation_sidebar' %>
 <div id="content" class="col-md-9">
   <%= render 'order_pages' %>
-  <%= bootstrap_form_for @exhibit, url: exhibit_contacts_path(@exhibit),
-      style: :horizontal, html: {class: 'exhibit-contacts'} do |f| %>
-    <h3><%= t :".contacts" %></h3>
-    <p class="instructions"><%= t :'.instructions' %></p>
-    <div class="panel-group dd contacts_admin" data-behavior="nestable" data-max-depth="1">
-      <ol class="dd-list">
-        <%= f.fields_for :contacts do |c| %>
-          <%= render partial: 'contact', locals: {f: c} %>
-        <% end %>
-      </ol>
-    </div>
-    <div class="form-actions" style="margin-top: 1em;">
-
-      <%= exhibit_create_link Spotlight::Contact.new, class: "btn btn-primary" %>
-      <div class="primary-actions">
-        <%= f.submit nil, class: 'btn btn-primary' %>
-      </div>
-    </div>
+  <% if can? :manage, Spotlight::Contact.new(exhibit: @exhibit) %>
+  <%= render 'contacts_form' %>
   <% end %>
 </div>