blacklight-spotlight 0.4.1 → 0.5.0

data/app/models/concerns/spotlight/user.rb

@@ -1,28 +1,34 @@
-module Spotlight::User
-  extend ActiveSupport::Concern
-  included do
-    has_many :roles, class_name: 'Spotlight::Role'
+module Spotlight
+  ##
+  # Spotlight user mixins for roles
+  module User
+    extend ActiveSupport::Concern
+    included do
+      has_many :roles, class_name: 'Spotlight::Role'
 
-    before_create :add_default_roles
-  end
+      before_create :add_default_roles
+    end
 
-  def superadmin?
-    admin_roles.where(exhibit_id: nil).any?
-  end
+    def superadmin?
+      admin_roles.where(exhibit_id: nil).any?
+    end
 
-  def admin_roles
-    roles.where(role: 'admin')
-  end
+    def admin_roles
+      roles.where(role: 'admin')
+    end
 
-  def add_default_roles
-    roles.build role: 'admin' unless self.class.any?
-  end
+    def add_default_roles
+      roles.build role: 'admin' unless self.class.any?
+    end
 
-  alias_attribute :user_key, :email
+    alias_attribute :user_key, :email
 
-  module ClassMethods
-    def find_by_user_key(key)
-      find_by email: key
+    ##
+    # Class-level user mixins
+    module ClassMethods
+      def find_by_user_key(key)
+        find_by email: key
+      end
     end
   end
 end

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

@@ -1,39 +1,45 @@
-module SirTrevorRails::Blocks
-  class BrowseBlock < SirTrevorRails::Block
+module SirTrevorRails
+  module Blocks
+    ##
+    # Multi-up browse block
+    class BrowseBlock < SirTrevorRails::Block
+      attr_reader :solr_helper
 
-    attr_reader :solr_helper
-  
-    def with_solr_helper solr_helper
-      @solr_helper = solr_helper
-    end
+      def with_solr_helper(solr_helper)
+        @solr_helper = solr_helper
+      end
 
-    def search_options id
-      (items.find { |x| x[:id] == id }) || {}
-    end
+      def search_options(id)
+        (items.detect { |x| x[:id] == id }) || {}
+      end
 
-    def searches
-      ids = items.map { |v| v[:id] }
-      @searches ||= parent.exhibit.searches.published.where(slug: ids).sort { |a,b| order.index(a.id) <=> order.index(b.id) }
-    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 searches?
-      !searches.empty?
-    end
+      def searches?
+        !searches.empty?
+      end
 
-    def items
-      item.values.select { |x| x[:display] == "true" }
-    end
+      def item_ids
+        items.map { |v| v[:id] }
+      end
 
-    def order
-      items.sort_by { |x| x[:weight] }.map { |x| x[:id] }
-    end
+      def items
+        item.values.select { |x| x[:display] == 'true' }
+      end
 
-    def display_item_counts?
-      send(:'display-item-counts') == "true"
-    end
-    
-    def item_count category
-      solr_helper.get_search_results(category.query_params).first["response"]["numFound"]
+      def order
+        items.sort_by { |x| x[:weight] }.map { |x| x[:id] }
+      end
+
+      def display_item_counts?
+        send(:'display-item-counts') == 'true'
+      end
+
+      def item_count(category)
+        solr_helper.search_results(category.query_params, solr_helper.search_params_logic).first['response']['numFound']
+      end
     end
   end
-end
+end

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

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

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

@@ -1,5 +1,9 @@
-module SirTrevorRails::Blocks
-  class OembedBlock < SirTrevorRails::Block
-    include Textable
+module SirTrevorRails
+  module Blocks
+    ##
+    # OEmbed consumer with text
+    class OembedBlock < SirTrevorRails::Block
+      include Textable
+    end
   end
-end
+end

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

@@ -1,29 +1,35 @@
-module SirTrevorRails::Blocks
-  class SearchResultsBlock < SirTrevorRails::Block
-    def query_params
-      if search
-        search.query_params
-      else
-        {}
+module SirTrevorRails
+  module Blocks
+    ##
+    # Embed search results (from a browse category) into the page
+    class SearchResultsBlock < SirTrevorRails::Block
+      def query_params
+        if search
+          search.query_params
+        else
+          {}
+        end
       end
-    end
 
-    def search
-      searches.first
-    end
-    
-    def searches
-      ids = items.map { |v| v[:id] }
-      @searches ||= parent.exhibit.searches.published.where(slug: ids).sort { |a,b| order.index(a.id) <=> order.index(b.id) }
-    end
+      def search
+        searches.first
+      end
 
-    def searches?
-      !searches.empty?
-    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 items
-      item.values.select { |x| x[:display] == "true" }
-    end
+      def item_ids
+        items.map { |v| v[:id] }
+      end
+
+      def searches?
+        !searches.empty?
+      end
 
+      def items
+        item.values.select { |x| x[:display] == 'true' }
+      end
+    end
   end
-end
+end

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

@@ -1,56 +1,57 @@
-module SirTrevorRails::Blocks
-  class SolrDocumentsBlock < SirTrevorRails::Block
-    include Textable
-    attr_reader :solr_helper
-  
-    def with_solr_helper solr_helper
-      @solr_helper = solr_helper
-    end
+module SirTrevorRails
+  module Blocks
+    ##
+    # Multi-up document viewer with text block
+    class SolrDocumentsBlock < SirTrevorRails::Block
+      include Textable
+      attr_reader :solr_helper
+
+      def with_solr_helper(solr_helper)
+        @solr_helper = solr_helper
+      end
 
-    def document_options id
-      (items.find { |x| x[:id] == id }) || {}
-    end
+      def each_document
+        return to_enum(:each_document) unless block_given?
 
-    def documents
-      @documents ||= begin
-        doc_ids = items.map { |v| v[:id] }
-        _, documents = solr_helper.fetch(doc_ids)
-        documents.sort { |a,b| document_order.index(a.id) <=> document_order.index(b.id) }
+        items.each do |i|
+          document = documents.detect { |doc| doc.id == i[:id] }
+          yield i, document if document
+        end
       end
-    end
 
-    def documents?
-      documents.present?
-    end
+      def documents
+        @documents ||= begin
+          doc_ids = items.map { |v| v[:id] }
+          _, documents = solr_helper.fetch(doc_ids)
+          documents
+        end
+      end
 
-    def items
-      (item || {}).values.select { |x| x[:display] == "true" }
-    end
+      def documents?
+        each_document.any?
+      end
 
-    def document_order
-      items.sort_by { |x| x[:weight] }.map { |x| x[:id] }
-    end
+      def items
+        (item || {}).values.select { |x| x[:display] == 'true' }
+      end
 
-    def primary_caption?
-      primary_caption_field.present? && send(:'show-primary-caption')
-    end
+      def primary_caption?
+        primary_caption_field.present? && send(:'show-primary-caption')
+      end
 
-    def secondary_caption?
-      secondary_caption_field.present? && send(:'show-secondary-caption')
-    end
+      def secondary_caption?
+        secondary_caption_field.present? && send(:'show-secondary-caption')
+      end
 
-    def primary_caption_field
-      val = send(:'primary-caption-field')
-      unless val.blank?
-        val
+      def primary_caption_field
+        val = send(:'primary-caption-field')
+        val unless val.blank?
       end
-    end
 
-    def secondary_caption_field
-      val = send(:'secondary-caption-field')
-      unless val.blank?
-        val
+      def secondary_caption_field
+        val = send(:'secondary-caption-field')
+        val unless val.blank?
       end
     end
   end
-end
+end

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

@@ -1,16 +1,20 @@
-module SirTrevorRails::Blocks
-  class SolrDocumentsCarouselBlock < SirTrevorRails::Blocks::SolrDocumentsBlock
-    def max_height
-      send(:'max-height')
-    end
+module SirTrevorRails
+  module Blocks
+    ##
+    # Carousel with documents and text block
+    class SolrDocumentsCarouselBlock < SirTrevorRails::Blocks::SolrDocumentsBlock
+      def max_height
+        send(:'max-height')
+      end
 
-    def interval
-      val = send(:'auto-play-images')
-      if val == "true"
-        send(:'auto-play-images-interval')
-      else
-        false
+      def interval
+        val = send(:'auto-play-images')
+        if val == 'true'
+          send(:'auto-play-images-interval')
+        else
+          false
+        end
       end
     end
   end
-end
+end

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

@@ -1,4 +1,8 @@
-module SirTrevorRails::Blocks
-  class SolrDocumentsEmbedBlock < SirTrevorRails::Blocks::SolrDocumentsBlock
+module SirTrevorRails
+  module Blocks
+    ##
+    # Embed documents (using a special blacklight view configuration) and text block
+    class SolrDocumentsEmbedBlock < SirTrevorRails::Blocks::SolrDocumentsBlock
+    end
   end
-end
+end

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

@@ -1,4 +1,8 @@
-module SirTrevorRails::Blocks
-  class SolrDocumentsFeaturesBlock < SirTrevorRails::Blocks::SolrDocumentsBlock
+module SirTrevorRails
+  module Blocks
+    ##
+    # Documents with a side navigation block
+    class SolrDocumentsFeaturesBlock < SirTrevorRails::Blocks::SolrDocumentsBlock
+    end
   end
-end
+end

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

@@ -1,4 +1,8 @@
-module SirTrevorRails::Blocks
-  class SolrDocumentsGridBlock < SirTrevorRails::Blocks::SolrDocumentsBlock
+module SirTrevorRails
+  module Blocks
+    ##
+    # "Interesting" layout of document images, good for large numbers of documents
+    class SolrDocumentsGridBlock < SirTrevorRails::Blocks::SolrDocumentsBlock
+    end
   end
-end
+end

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

@@ -1,26 +1,26 @@
-module SirTrevorRails::Blocks
-  module Textable
-
-    def text?
-      text.present?
-    end
+module SirTrevorRails
+  module Blocks
+    ##
+    # Mixin for blocks that display text
+    module Textable
+      def text?
+        text.present?
+      end
 
-    def text_align
-      send(:'text-align')
-    end
+      def text_align
+        send(:'text-align')
+      end
 
-    def content_align
-      text_align == "left" ? "right" : "left" if text?
-    end
+      def content_align
+        text_align == 'left' ? 'right' : 'left' if text?
+      end
 
-    def text
-      val = super
+      def text
+        val = super
 
-      # empty, in sir-trevor speak
-      unless val == "<p><br></p>"
-        val
+        # empty, in sir-trevor speak
+        val unless val == '<p><br></p>'
       end
     end
-
   end
 end