blacklight-spotlight 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d68cf5423c8ab3b9eaefd0b0cbdccafaf2eaf8d4
-  data.tar.gz: 5c81452e6aec254a83c977e1905edadc22142df6
+  metadata.gz: 7796437b15cb33ea287b007cfdc234f32dbf4ebb
+  data.tar.gz: 14073a32190fea37021fa92b517d12511f22c02b
 SHA512:
-  metadata.gz: d0b21a7dd31dc34df83e91db7f2861d0c15260675348e98376b5cba29a67e441aba2319e72857ad51537068cbd0d5b67c1594c1b560a3bc6b143840f48d0530f
-  data.tar.gz: 2a86b06e1ee71519050007e5e3b5cbd20f5d5ed3ab34b32acde37785486a56d6661e25bbafc915d775668d743a1a7da10ce2b48562acb9b0ace96d9447837e58
+  metadata.gz: 5e44725a667615c9270a471493e28d1e79c20d52b5606d66e57faf62a2ef276941f7afc86df470a0f946c816d5cecbcfb71c4619f15d7db1764023765da238e3
+  data.tar.gz: c0b91e1e8d835c5e96c444eab21c1d56be0e3755cb382d81683564d15214010f8ddc1452163dc6f1dfc7e560390de5d8ac868bad9adaf034633ebd180fad5de9

data/app/controllers/spotlight/resources_controller.rb

@@ -5,9 +5,9 @@ module Spotlight
     before_action :authenticate_user!, except: [:show]
 
     load_and_authorize_resource :exhibit, class: Spotlight::Exhibit
-    before_action :build_resource, only: [:create]
 
-    load_and_authorize_resource through: :exhibit
+    # explicit options support better subclassing
+    load_and_authorize_resource through: :exhibit, instance_name: :resource, through_association: :resources
 
     def new
       add_breadcrumb t(:'spotlight.exhibits.breadcrumb', title: @exhibit.title), exhibit_root_path(@exhibit)
@@ -20,11 +20,12 @@ module Spotlight
 
     def create
       if @resource.save_and_index
-        redirect_to admin_exhibit_catalog_path(@resource.exhibit, sort: :timestamp)
+        redirect_to spotlight.admin_exhibit_catalog_path(@resource.exhibit, sort: :timestamp)
       else
         render action: 'new'
       end
     end
+    alias update create
 
     def monitor
       render json: current_exhibit.reindex_progress
@@ -38,12 +39,13 @@ module Spotlight
 
     protected
 
-    def resource_params
-      params.require(:resource).permit(:url, data: params[:resource][:data].try(:keys))
+    def resource_class
+      Spotlight::Resource
     end
 
-    def build_resource
-      @resource ||= @exhibit.resources.build(resource_params)
+    def resource_params
+      params.require(:resource).tap { |x| x['type'] ||= resource_class.name }
+            .permit(:url, :type, *resource_class.stored_attributes[:data], data: params[:resource][:data].try(:keys))
     end
   end
 end

data/app/models/sir_trevor_rails/blocks/browse_block.rb

@@ -3,6 +3,8 @@ module SirTrevorRails
     ##
     # Multi-up browse block
     class BrowseBlock < SirTrevorRails::Block
+      include Displayable
+
       attr_reader :solr_helper
 
       def with_solr_helper(solr_helper)
@@ -15,7 +17,7 @@ module SirTrevorRails
 
       def searches
         @searches ||= parent.exhibit.searches.published.where(slug: item_ids).sort do |a, b|
-          order.index(a.slug) <=> order.index(b.slug)
+          ordered_items.index(a.slug) <=> ordered_items.index(b.slug)
         end
       end
 
@@ -23,27 +25,9 @@ module SirTrevorRails
         !searches.empty?
       end
 
-      def item_ids
-        items.map { |v| v[:id] }
-      end
-
-      def items
-        item_values.select { |x| x[:display] == 'true' }
-      end
-
-      def order
-        items.sort_by { |x| x[:weight] }.map { |x| x[:id] }
-      end
-
       def display_item_counts?
         send(:'display-item-counts') == 'true'
       end
-
-      private
-
-      def item_values
-        item.try(:values) || []
-      end
     end
   end
 end

data/app/models/sir_trevor_rails/blocks/displayable.rb

@@ -0,0 +1,25 @@
+module SirTrevorRails
+  module Blocks
+    ##
+    # Mixin for blocks that display text
+    module Displayable
+      def items
+        item_values.select { |x| x[:display] == 'true' }
+      end
+
+      def item_ids
+        items.map { |v| v[:id] }
+      end
+
+      def ordered_items
+        items.sort_by { |x| x[:weight] }.map { |x| x[:id] }
+      end
+
+      private
+
+      def item_values
+        Array((item.values if item.present?))
+      end
+    end
+  end
+end

data/app/models/sir_trevor_rails/blocks/featured_pages_block.rb

@@ -3,31 +3,21 @@ module SirTrevorRails
     ##
     # Multi-up featured page block
     class FeaturedPagesBlock < SirTrevorRails::Block
+      include Displayable
+
       def page_options(id)
         (items.detect { |x| x[:id] == id }) || {}
       end
 
       def pages
         @pages ||= parent.exhibit.pages.published.where(slug: item_ids).sort do |a, b|
-          order.index(a.slug) <=> order.index(b.slug)
+          ordered_items.index(a.slug) <=> ordered_items.index(b.slug)
         end
       end
 
       def pages?
         !pages.empty?
       end
-
-      def item_ids
-        items.map { |v| v[:id] }
-      end
-
-      def items
-        item.values.select { |x| x[:display] == 'true' }
-      end
-
-      def order
-        items.sort_by { |x| x[:weight] }.map { |x| x[:id] }
-      end
     end
   end
 end

data/app/models/sir_trevor_rails/blocks/search_results_block.rb

@@ -3,6 +3,8 @@ module SirTrevorRails
     ##
     # Embed search results (from a browse category) into the page
     class SearchResultsBlock < SirTrevorRails::Block
+      include Displayable
+
       def query_params
         if search
           search.query_params
@@ -16,20 +18,12 @@ module SirTrevorRails
       end
 
       def searches
-        @searches ||= parent.exhibit.searches.published.where(slug: item_ids).sort { |a, b| order.index(a.id) <=> order.index(b.id) }
-      end
-
-      def item_ids
-        items.map { |v| v[:id] }
+        @searches ||= parent.exhibit.searches.published.where(slug: item_ids).sort { |a, b| ordered_items.index(a.id) <=> ordered_items.index(b.id) }
       end
 
       def searches?
         !searches.empty?
       end
-
-      def items
-        item.values.select { |x| x[:display] == 'true' }
-      end
     end
   end
 end

data/app/models/sir_trevor_rails/blocks/solr_documents_block.rb

@@ -4,6 +4,7 @@ module SirTrevorRails
     # Multi-up document viewer with text block
     class SolrDocumentsBlock < SirTrevorRails::Block
       include Textable
+      include Displayable
       attr_reader :solr_helper
 
       def with_solr_helper(solr_helper)
@@ -31,10 +32,6 @@ module SirTrevorRails
         each_document.any?
       end
 
-      def items
-        (item || {}).values.select { |x| x[:display] == 'true' }
-      end
-
       def primary_caption?
         primary_caption_field.present? && send(:'show-primary-caption')
       end

data/app/uploaders/spotlight/avatar_uploader.rb

@@ -18,7 +18,7 @@ module Spotlight
     end
 
     def default_url
-      ActionController::Base.helpers.asset_path('fallback/' + [version_name, 'default.png'].compact.join('_'))
+      ActionController::Base.helpers.image_path('spotlight/fallback/' + [version_name, 'default.png'].compact.join('_'))
     end
   end
 end

data/app/uploaders/spotlight/featured_image_uploader.rb

@@ -23,7 +23,7 @@ module Spotlight
     end
 
     def default_url
-      ActionController::Base.helpers.asset_path('fallback/' + [version_name, 'default.png'].compact.join('_'))
+      ActionController::Base.helpers.image_path('spotlight/fallback/' + [version_name, 'default.png'].compact.join('_'))
     end
   end
 end

data/app/uploaders/spotlight/item_uploader.rb

@@ -19,7 +19,7 @@ module Spotlight
     end
 
     def default_url
-      ActionController::Base.helpers.asset_path('fallback/' + [version_name, 'default.png'].compact.join('_'))
+      ActionController::Base.helpers.image_path('spotlight/fallback/' + [version_name, 'default.png'].compact.join('_'))
     end
   end
 end

data/app/uploaders/spotlight/masthead_uploader.rb

@@ -16,7 +16,7 @@ module Spotlight
     end
 
     def default_url
-      ActionController::Base.helpers.asset_path('fallback/' + [version_name, 'default.png'].compact.join('_'))
+      ActionController::Base.helpers.image_path('spotlight/fallback/' + [version_name, 'default.png'].compact.join('_'))
     end
   end
 end

data/app/views/spotlight/resources/_form.html.erb

@@ -0,0 +1,9 @@
+<%= bootstrap_form_for([current_exhibit, @resource]) do |f| %>
+  <%= f.text_field :url  %>
+  <div class="form-actions">
+    <div class="primary-actions">
+      <%= cancel_link @resource, :back, class: 'btn btn-default' %>
+      <%= f.submit t('.add_item'), class: 'btn btn-primary' %>
+    </div>
+  </div>
+<% end if can? :manage, @resource %>

data/config/locales/spotlight.en.yml

@@ -506,6 +506,7 @@ en:
       form:
         needs_provider: "Could not find an appropriate importer"
         has_provider: "Ready to import"
+        add_item: "Add item"
       upload:
         csv:
           success: "'%{file_name}' has been uploaded.  An email will be sent to you once indexing is complete."

data/lib/generators/spotlight/scaffold_resource_generator.rb

@@ -0,0 +1,70 @@
+require 'rails/generators'
+
+# :nodoc:
+module Spotlight
+  # spotlight:scaffold_resource generator
+  class ScaffoldResource < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+    def create_document_builder
+      create_file "app/services/#{file_name}_builder.rb", <<-FILE.strip_heredoc
+        class #{class_name}Builder < Spotlight::SolrDocumentBuilder
+          def to_solr
+            return to_enum(:to_solr) unless block_given?
+
+            # TODO: your implementation here
+            # yield { id: resource.id }
+          end
+        end
+    FILE
+    end
+
+    def create_model
+      create_file "app/models/#{file_name}_resource.rb", <<-FILE.strip_heredoc
+        class #{class_name}Resource < Spotlight::Resource
+          self.document_builder_class = #{class_name}Builder
+        end
+      FILE
+    end
+
+    def create_controller
+      create_file "app/controllers/#{file_name}_resources_controller.rb", <<-FILE.strip_heredoc
+        class #{class_name}ResourcesController < Spotlight::ResourcesController
+          private
+
+          def resource_class
+            #{class_name}Resource
+          end
+        end
+      FILE
+    end
+
+    def create_form
+      create_file "app/views/#{file_name}_resources/_form.html.erb", <<-FILE.strip_heredoc
+      <%= bootstrap_form_for([current_exhibit, @resource.becomes(#{class_name}Resource)], as: :resource) do |f| %>
+        <%= f.text_field :url  %>
+        <div class="form-actions">
+          <div class="primary-actions">
+            <%= cancel_link @resource, :back, class: 'btn btn-default' %>
+            <%= f.submit t('.add_item'), class: 'btn btn-primary' %>
+          </div>
+        </div>
+      <% end if can? :manage, @resource %>
+      FILE
+    end
+  end
+
+  def inject_configuration
+    inject_into_file 'config/initializers/spotlight_initializer.rb' do
+      "\n  Spotlight::Engine.config.external_resources_partials += ['#{file_name}_resources/form']\n"
+    end
+  end
+
+  def create_routes
+    route <<-FILE.strip_heredoc
+      resources :exhibits, only: [] do
+        resources :#{file_name}_resources, only: [:create, :update] do
+        end
+      end
+    FILE
+  end
+end

data/lib/spotlight/engine.rb

@@ -34,6 +34,8 @@ module Spotlight
     require 'sir_trevor_rails'
     require 'openseadragon'
 
+    config.assets.precompile += %w(spotlight/fallback/*.png)
+
     config.autoload_paths += %W(
       #{config.root}/app/builders
       #{config.root}/app/controllers/concerns

data/lib/spotlight/version.rb

@@ -1,3 +1,3 @@
 module Spotlight
-  VERSION = '0.25.0'.freeze
+  VERSION = '0.26.0'.freeze
 end

data/spec/models/sir_trevor_rails/blocks/featured_pages_block_spec.rb

@@ -0,0 +1,20 @@
+describe SirTrevorRails::Blocks::FeaturedPagesBlock do
+  let(:page) { FactoryGirl.create(:feature_page) }
+  let(:block_data) { {} }
+  subject { described_class.new({ type: '', data: block_data }, page) }
+
+  describe '#items' do
+    it 'is the array of items with display set to true' do
+      block_data[:item] = {
+        '0': { id: 'abc123', display: 'true' },
+        '1': { id: 'xyz321', display: 'false' }
+      }
+      expect(subject.items.length).to eq 1
+      expect(subject.items).to eq([{ id: 'abc123', display: 'true' }])
+    end
+
+    it 'is an empty array when there is no browse category' do
+      expect(subject.items).to eq([])
+    end
+  end
+end

data/spec/models/sir_trevor_rails/blocks/search_results_block_spec.rb

@@ -0,0 +1,20 @@
+describe SirTrevorRails::Blocks::SearchResultsBlock do
+  let(:page) { FactoryGirl.create(:feature_page) }
+  let(:block_data) { {} }
+  subject { described_class.new({ type: '', data: block_data }, page) }
+
+  describe '#items' do
+    it 'is the array of items with display set to true' do
+      block_data[:item] = {
+        '0': { id: 'abc123', display: 'true' },
+        '1': { id: 'xyz321', display: 'false' }
+      }
+      expect(subject.items.length).to eq 1
+      expect(subject.items).to eq([{ id: 'abc123', display: 'true' }])
+    end
+
+    it 'is an empty array when there is no browse category' do
+      expect(subject.items).to eq([])
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-spotlight
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-09 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -701,6 +701,7 @@ files:
 - Rakefile
 - app/assets/images/spotlight/blocks/sir-trevor-icons.svg
 - app/assets/images/spotlight/default_thumbnail.jpg
+- app/assets/images/spotlight/fallback/default.png
 - app/assets/javascripts/spotlight/add_new_page_button.js
 - app/assets/javascripts/spotlight/appearance.js
 - app/assets/javascripts/spotlight/application.js
@@ -858,6 +859,7 @@ files:
 - app/models/concerns/spotlight/solr_document/uploaded_resource.rb
 - app/models/concerns/spotlight/user.rb
 - app/models/sir_trevor_rails/blocks/browse_block.rb
+- app/models/sir_trevor_rails/blocks/displayable.rb
 - app/models/sir_trevor_rails/blocks/featured_pages_block.rb
 - app/models/sir_trevor_rails/blocks/oembed_block.rb
 - app/models/sir_trevor_rails/blocks/search_results_block.rb
@@ -1024,6 +1026,7 @@ files:
 - app/views/spotlight/pages/preview.html.erb
 - app/views/spotlight/pages/show.html.erb
 - app/views/spotlight/resources/_external_resources_form.html.erb
+- app/views/spotlight/resources/_form.html.erb
 - app/views/spotlight/resources/_missing_external_resources_partials.html.erb
 - app/views/spotlight/resources/csv_upload/_form.html.erb
 - app/views/spotlight/resources/json_upload/_form.html.erb
@@ -1120,6 +1123,7 @@ files:
 - db/migrate/20160711121314_add_default_view_to_spotlight_searches.rb
 - lib/blacklight/spotlight.rb
 - lib/generators/spotlight/install_generator.rb
+- lib/generators/spotlight/scaffold_resource_generator.rb
 - lib/generators/spotlight/templates/catalog_controller.rb
 - lib/generators/spotlight/templates/config/initializers/riiif.rb
 - lib/generators/spotlight/templates/config/initializers/spotlight_initializer.rb
@@ -1244,6 +1248,8 @@ files:
 - spec/lib/spotlight/controller_spec.rb
 - spec/mailers/spotlight/indexing_complete_mailer_spec.rb
 - spec/models/sir_trevor_rails/blocks/browse_block_spec.rb
+- spec/models/sir_trevor_rails/blocks/featured_pages_block_spec.rb
+- spec/models/sir_trevor_rails/blocks/search_results_block_spec.rb
 - spec/models/sir_trevor_rails/blocks/solr_documents_block_spec.rb
 - spec/models/sir_trevor_rails/blocks/textable_spec.rb
 - spec/models/solr_document_spec.rb
@@ -1512,6 +1518,8 @@ test_files:
 - spec/lib/spotlight/controller_spec.rb
 - spec/mailers/spotlight/indexing_complete_mailer_spec.rb
 - spec/models/sir_trevor_rails/blocks/browse_block_spec.rb
+- spec/models/sir_trevor_rails/blocks/featured_pages_block_spec.rb
+- spec/models/sir_trevor_rails/blocks/search_results_block_spec.rb
 - spec/models/sir_trevor_rails/blocks/solr_documents_block_spec.rb
 - spec/models/sir_trevor_rails/blocks/textable_spec.rb
 - spec/models/solr_document_spec.rb