blacklight 4.9.0 → 5.0.0.pre1

data/lib/blacklight/rails/routes.rb

@@ -0,0 +1,17 @@
+module ActionDispatch::Routing
+  class Mapper
+    # example
+    #   blacklight_for :catalog
+    #   blacklight_for :catalog, :dashboard
+    #   blacklight_for :catalog, except: [ :saved_searches, :feedback ]
+    #   blacklight_for :catalog, only: [ :saved_searches, :solr_document ]
+    #   blacklight_for :catalog, constraints: {id: /[0-9]+/ }
+    def blacklight_for(*resources)
+      options = resources.extract_options!
+      resources.map!(&:to_sym)
+
+      Blacklight::Routes.new(self, options.merge(resources: resources)).draw
+    
+    end
+  end
+end

data/lib/blacklight/routes.rb

@@ -1,40 +1,32 @@
 # -*- encoding : utf-8 -*-
+require 'deprecation'
 module Blacklight
   class Routes
+    extend Deprecation
 
-    # adds as class and instance level accessors, default_route_sets
-    # returns an array of symbols for method names that define routes. 
-    # Order is important:.  (e.g. /catalog/email precedes /catalog/:id)
-    #
-    # Add-ons that want to add routes into default routing might
-    # monkey-patch Blacklight::Routes, say:
-    #
-    #     module MyWidget::Routes
-    #       extend ActiveSupport::Concern
-    #       included do |klass|
-    #         klass.default_route_sets += [:widget_routing]
-    #       end
-    #       def widget_routing(primary_resource)
-    #         get "#{primary_resource}/widget", "#{primary_resource}#widget"
-    #       end
-    #     end
-    #     Blacklight::Routes.send(:include, MyWidget::Routes)
-    class_attribute :default_route_sets
-    self.default_route_sets = [:bookmarks, :search_history, :saved_searches, :catalog, :solr_document, :feedback]
+    attr_reader :resources 
 
     def initialize(router, options)
       @router = router
       @options = options
+      @resources = options.fetch(:resources, [:catalog])
     end
 
     def draw
       route_sets.each do |r|
-        self.send(r)
+        self.send(r, primary_resource)
+      end
+      resources.each do |r|
+        self.map_resource(r)
       end
     end
 
     protected
 
+    def primary_resource
+      resources.first
+    end
+
     def add_routes &blk
       @router.instance_exec(@options, &blk)
     end
@@ -43,15 +35,20 @@ module Blacklight
       (@options[:only] || default_route_sets) - (@options[:except] || [])
     end
 
+    def default_route_sets
+      # Order is important here.  (e.g. /catalog/email precedes /catalog/:id)
+      [:bookmarks, :search_history, :saved_searches, :export, :solr_document, :feedback]
+    end
+
     module RouteSets
-      def bookmarks
+      def bookmarks(_)
         add_routes do |options|
           delete "bookmarks/clear", :to => "bookmarks#clear", :as => "clear_bookmarks"
           resources :bookmarks
         end
       end
   
-      def search_history
+      def search_history(_)
         add_routes do |options|
           get "search_history",             :to => "search_history#index",   :as => "search_history"
           delete "search_history/clear",       :to => "search_history#clear",   :as => "clear_search_history"          
@@ -59,7 +56,7 @@ module Blacklight
       end
   
   
-      def saved_searches
+      def saved_searches(_)
         add_routes do |options|
           delete "saved_searches/clear",       :to => "saved_searches#clear",   :as => "clear_saved_searches"
           get "saved_searches",       :to => "saved_searches#index",   :as => "saved_searches"
@@ -69,36 +66,45 @@ module Blacklight
         end
       end
     
-      def catalog
-        add_routes do |options|
-          # Catalog stuff.
-          get 'catalog/opensearch', :as => "opensearch_catalog"
-          get 'catalog/citation', :as => "citation_catalog"
-          get 'catalog/email', :as => "email_catalog"
-          post 'catalog/email'
-          get 'catalog/sms', :as => "sms_catalog"
-          get 'catalog/endnote', :as => "endnote_catalog"
-          get "catalog/facet/:id", :to => 'catalog#facet', :as => 'catalog_facet'
-
+      def catalog(_=nil)
+        Deprecation.warn(Blacklight::Routes, "Blacklight::Routes.catalog is deprecated and will be removed in Blacklight 6.0.  Use Blacklight::Routes.map_resource(:catalog) instead.")
+        map_resource(:catalog)
+      end
 
-          get "catalog", :to => 'catalog#index', :as => 'catalog_index'
+      def map_resource(key)
+        add_routes do |options|
+          get "#{key}/facet/:id", :to => "#{key}#facet", :as => "#{key}_facet"
+          get "#{key}", :to => "#{key}#index", :as => "#{key}_index"
+        end
+      end
 
-          get 'catalog/:id/librarian_view', :to => "catalog#librarian_view", :as => "librarian_view_catalog"
+      def export(primary_resource)
+        add_routes do |options|
+          get "#{primary_resource}/opensearch", :as => "opensearch_#{primary_resource}"
+          get "#{primary_resource}/citation", :as => "citation_#{primary_resource}"
+          get "#{primary_resource}/email", :as => "email_#{primary_resource}"
+          post "#{primary_resource}/email"
+          get "#{primary_resource}/sms", :as => "sms_#{primary_resource}"
+          get "#{primary_resource}/endnote", :as => "endnote_#{primary_resource}"
         end
       end
 
-      def solr_document
+      def solr_document(primary_resource)
         add_routes do |options|
-          resources :solr_document,  :path => 'catalog', :controller => 'catalog', :only => [:show, :update] 
+
+          args = {only: [:show, :update]}
+          args[:constraints] = options[:constraints] if options[:constraints]
+
+          resources :solr_document, args.merge(path: primary_resource, controller: primary_resource)
 
           # :show and :update are for backwards-compatibility with catalog_url named routes
-          resources :catalog, :only => [:show, :update]
+          resources primary_resource, args
         end
       end
   
     
       # Feedback
-      def feedback
+      def feedback(_)
         add_routes do |options|
           get "feedback", :to => "feedback#show"    
           get "feedback/complete", :to => "feedback#complete"

data/lib/blacklight/solr.rb

@@ -4,5 +4,6 @@ module Blacklight::Solr
   autoload :Facets, 'blacklight/solr/facets'
   autoload :FacetPaginator, 'blacklight/solr/facet_paginator'
   autoload :Document, 'blacklight/solr/document'
+  autoload :Request, 'blacklight/solr/request'
   
 end

data/lib/blacklight/solr/document.rb

@@ -16,11 +16,6 @@ require 'rsolr'
 #
 
 module Blacklight::Solr::Document
-  extend Deprecation
-  self.deprecation_horizon = 'Blacklight 5.x'
-
-  autoload :Marc, 'blacklight/solr/document/marc'
-  autoload :MarcExport, 'blacklight/solr/document/marc_export'
   autoload :DublinCore, 'blacklight/solr/document/dublin_core'
   autoload :Email, 'blacklight/solr/document/email'
   autoload :Sms, 'blacklight/solr/document/sms'
@@ -35,7 +30,7 @@ module Blacklight::Solr::Document
   included do
     extend ActiveModel::Naming
     include Blacklight::Solr::Document::Extensions
-  end
+  end    
 
   attr_reader :solr_response
 
@@ -59,7 +54,7 @@ module Blacklight::Solr::Document
   # Helper method to check if value/multi-values exist for a given key.
   # The value can be a string, or a RegExp
   # Multiple "values" can be given; only one needs to match.
-  #
+  # 
   # Example:
   # doc.has?(:location_facet)
   # doc.has?(:location_facet, 'Clemons')
@@ -83,7 +78,7 @@ module Blacklight::Solr::Document
 
   def has_highlight_field? k
     return false if @solr_response['highlighting'].blank? or @solr_response['highlighting'][self.id].blank?
-
+    
     @solr_response['highlighting'][self.id].key? k.to_s
   end
 
@@ -128,66 +123,50 @@ module Blacklight::Solr::Document
     'catalog/document'
   end
 
-
+   
   # Returns a hash keyed by semantic tokens (see ExtendableClassMethods#semantic_fields), value is an array of
   # strings. (Array to handle multi-value fields). If no value(s)
-  # available, empty array is returned.
+  # available, empty array is returned. 
   #
   # Default implementation here uses ExtendableClassMethods#semantic_fields
-  # to just take values from Solr stored fields.
+  # to just take values from Solr stored fields. 
   # Extensions can over-ride this method to provide better/different lookup,
   # but extensions should call super and modify hash returned, to avoid
-  # unintentionally erasing values provided by other extensions.
+  # unintentionally erasing values provided by other extensions. 
   def to_semantic_values
     unless @semantic_value_hash
-      @semantic_value_hash = Hash.new([]) # default to empty array
+      @semantic_value_hash = Hash.new([]) # default to empty array   
       self.class.field_semantics.each_pair do |key, solr_field|
         value = self[solr_field]
         # Make single and multi-values all arrays, so clients
         # don't have to know.
         unless value.nil?
-          value = [value] unless value.kind_of?(Array)
+          value = [value] unless value.kind_of?(Array)      
           @semantic_value_hash[key] = value
         end
       end
     end
     return @semantic_value_hash
   end
-
-  def to_model
-    self
-  end
-
-  def persisted?
-    true
-  end
-
-
+  
+  
   # Certain class-level methods needed for the document-specific
   # extendability architecture
   module ClassMethods
 
     attr_writer :unique_key
     def unique_key
-      # XXX Blacklight.config[:unique_key] should be deprecated soon
-      if Blacklight.respond_to?(:config) and Blacklight.config[:unique_key]
-        Deprecation.warn(self, "Setting the unique key using Blacklight.config[:unique_key] has been deprecated. Use the SolrDocument.unique_key= setter instead")
-        @unique_key ||= Blacklight.config[:unique_key]
-      end
-      @unique_key ||= 'id'
-
-      @unique_key
+      @unique_key ||= 'id' 
     end
 
      def connection
-       Deprecation.warn(self, "Document.connection is deprecated and will be removed in Blacklight 5.0")
-       @connection ||= Blacklight.solr
+      @connection ||= Blacklight.solr
      end
-
+    
     # Returns array of hashes of registered extensions. Each hash
     # has a :module_obj key and a :condition_proc key. Usually this
     # method is only used internally in #apply_extensions, but if you
-
+ 
     # Class-level method for accessing/setting semantic mappings
     # for solr stored fields. Can be set by local app, key is
     # a symbol for a semantic, value is a solr _stored_ field.
@@ -197,13 +176,13 @@ module Blacklight::Solr::Document
     #
     # Currently documented semantic tokens, not all may be
     # used by core BL, but some may be used by plugins present
-    # or future.
-    # :title, :author, :year, :language => User-presentable strings.
+    # or future. 
+    # :title, :author, :year, :language => User-presentable strings. 
     def field_semantics
       @field_semantics ||= {}
-    end
+    end    
   end
-
-
-
+  
+ 
+  
 end

data/lib/blacklight/solr/facet_paginator.rb

@@ -12,10 +12,6 @@ module Blacklight::Solr
   # so we cannot know how many "pages" there are.
   #
   class FacetPaginator    
-    extend Deprecation
-
-    self.deprecation_horizon = 'blacklight version 6.0.0'
-    
     # What request keys will we use for the parameters need. Need to
     # make sure they do NOT conflict with catalog/index request params,
     # and need to make them accessible in a list so we can easily
@@ -25,7 +21,7 @@ module Blacklight::Solr
     class << self; attr_accessor :request_keys end # create a class method
     def request_keys ; self.class.request_keys ; end # shortcut
     
-    attr_reader :total_count, :items, :offset, :limit, :sort
+    attr_reader :total, :items, :offset, :limit, :sort
     
     # all_facet_values is a list of facet value objects returned by solr,
     # asking solr for n+1 facet values.
@@ -37,74 +33,54 @@ module Blacklight::Solr
     def initialize(all_facet_values, arguments)
       # to_s.to_i will conveniently default to 0 if nil
       @offset = arguments[:offset].to_s.to_i 
-      @limit =  arguments[:limit].to_s.to_i
+      @limit =  arguments[:limit].to_s.to_i if arguments[:limit]           
       # count is solr's default
       @sort = arguments[:sort] || "count" 
-      @total_count = all_facet_values.size
-      @items = items_for_limit(all_facet_values)
-    end
-
-    alias_method :total, :total_count
-
-    def prev_page
-      current_page - 1 unless first_page?
-    end
-
-    def current_page
-      if limit == 0 #check for divide by zero
-        1
-      else
-        @offset / limit + 1
+      
+      total = all_facet_values.size
+      if (@limit)
+        @items = all_facet_values.slice(0, @limit)
+        @has_next = total > @limit
+        @has_previous = @offset > 0
+      else # nil limit
+        @items = all_facet_values
+        @has_next = false
+        @has_previous = false
       end
     end
 
-    def next_page
-      current_page + 1 unless last_page?
+    def current_page
+      1 + @offset/@limit
     end
    
-    #@deprecated
     def has_next?
-      !last_page?
+      @has_next
     end
-    deprecation_deprecate :has_next?
 
-    #@deprecated
     def has_previous?
-      !first_page?
+      @has_previous
     end
-    deprecation_deprecate :has_next?
 
     def last_page?
-      current_page >= total_pages
+      !has_next?
     end
 
     def first_page?
-      current_page == 1
+      !has_previous?
     end
 
-    def total_pages
-      if limit == 0 #check for divide by zero
-        1
-      else
-        (total_count.to_f / limit).ceil
-      end
-    end      
-
-    # Pass in a desired solr facet solr key ('count' or 'index', see
-    # http://wiki.apache.org/solr/SimpleFacetParameters#facet.limit
-    # under facet.sort ), and your current request params.
-    # Get back params suitable to passing to an ActionHelper method for
-    # creating a url, to resort by that method.
-    def params_for_resort_url(sort_method, params)
-      # When resorting, we've got to reset the offset to start at beginning,
-      # no way to make it make sense otherwise.
-      params.merge(request_keys[:sort] => sort_method, request_keys[:page] => nil)
-    end
 
-    private
-      # setting limit to 0 implies no limit
-      def items_for_limit(values)
-        limit != 0 ? values.slice(offset, limit) : values
-      end
+   # Pass in a desired solr facet solr key ('count' or 'index', see
+   # http://wiki.apache.org/solr/SimpleFacetParameters#facet.limit
+   # under facet.sort ), and your current request params.
+   # Get back params suitable to passing to an ActionHelper method for
+   # creating a url, to resort by that method.
+   def params_for_resort_url(sort_method, params)
+     # When resorting, we've got to reset the offset to start at beginning,
+     # no way to make it make sense otherwise.
+     return params.merge(request_keys[:sort] => sort_method, request_keys[:page] => nil)
+   end
+    
   end
+  
 end

data/lib/blacklight/solr/request.rb

@@ -0,0 +1,45 @@
+class Blacklight::Solr::InvalidParameter < ArgumentError; end
+
+class Blacklight::Solr::Request < HashWithIndifferentAccess
+
+  SINGULAR_KEYS = %W{ facet fl q qt rows start spellcheck spellcheck.q sort 
+  per_page wt hl group defType}
+  ARRAY_KEYS = %W{facet.field facet.query facet.pivot fq hl.fl }
+
+  def initialize(constructor = {})
+    if constructor.is_a?(Hash)
+      super()
+      update(constructor)
+    else
+      super(constructor)
+    end
+    ARRAY_KEYS.each do |key|
+      self[key] ||= []
+    end
+  end
+
+  def append_filter_query(query)
+    self['fq'] << query
+  end
+
+  def append_facet_fields(values)
+    self['facet.field'] += Array(values)
+  end
+
+  def append_facet_query(values)
+    self['facet.query'] += Array(values)
+  end
+
+  def append_facet_pivot(query)
+    self['facet.pivot'] << query
+  end
+
+  def append_highlight_field(query)
+    self['hl.fl'] << query
+  end
+
+  def to_hash
+    reject {|key, value| ARRAY_KEYS.include?(key) && value.empty?}
+  end
+
+end