blacklight 5.19.2 → 6.0.0.pre1

data/lib/blacklight/routes/exportable.rb

@@ -0,0 +1,25 @@
+module Blacklight
+  module Routes
+    class Exportable
+      def initialize(defaults = {})
+        @defaults = defaults
+      end
+
+      def call(mapper, options = {})
+        options = @defaults.merge(options)
+
+        mapper.member do
+          mapper.match 'email', via: [:get, :post]
+          mapper.match 'sms', via: [:get, :post]
+          mapper.get 'citation'
+        end
+
+        mapper.collection do
+          mapper.match 'email', via: [:get, :post]
+          mapper.match 'sms', via: [:get, :post]
+          mapper.get 'citation'
+        end
+      end
+    end
+  end
+end

data/lib/blacklight/routes/searchable.rb

@@ -0,0 +1,20 @@
+module Blacklight
+  module Routes
+    class Searchable
+      def initialize(defaults = {})
+        @defaults = defaults
+      end
+
+      def call(mapper, options = {})
+        options = @defaults.merge(options)
+
+        mapper.match '/', action: 'index', as: 'search', via: [:get, :post]
+
+        mapper.post ":id/track", action: 'track', as: 'track'
+
+        mapper.get "opensearch"
+        mapper.get "facet/:id", action: 'facet', as: 'facet'
+      end
+    end
+  end
+end

data/lib/blacklight/solr.rb

@@ -1,12 +1,4 @@
 module Blacklight
   module Solr
-    require File.join(Blacklight::Engine.config.root, 'app', 'models', 'concerns', 'blacklight', 'document')
-    require File.join(Blacklight::Engine.config.root, 'app', 'models', 'concerns', 'blacklight', 'solr', 'document')
-
-    autoload :Repository, 'blacklight/solr/repository'
-    autoload :Request, 'blacklight/solr/request'
-    autoload :Response, 'blacklight/solr/response'
-    autoload :SearchBuilder, 'blacklight/solr/search_builder'
-    autoload :SearchBuilderBehavior, 'blacklight/solr/search_builder_behavior'
   end
-end
+end

data/lib/blacklight/utils.rb

@@ -3,19 +3,7 @@ module Blacklight
 
   module Utils
     def self.needs_attr_accessible?
-      if rails_3?
-        !strong_parameters_enabled?
-      else
-        protected_attributes_enabled?
-      end
-    end
-
-    def self.rails_3?
-      Rails::VERSION::MAJOR == 3
-    end
-
-    def self.strong_parameters_enabled?
-      defined?(ActionController::StrongParameters)
+      protected_attributes_enabled?
     end
 
     def self.protected_attributes_enabled?
@@ -28,20 +16,6 @@ module Blacklight
   class OpenStructWithHashAccess < OpenStruct
     delegate :keys, :each, :map, :has_key?, :key?, :include?, :empty?, :length, :delete, :delete_if, :keep_if, :clear, :reject!, :select!, :replace, :fetch, :to_json, :as_json, to: :to_h
 
-    if ::RUBY_VERSION < '2.0'
-      def []=(key, value)
-        send "#{key}=", value
-      end
-
-      def [](key)
-        send key
-      end
-
-      def respond_to? method, *args
-        super(method, *args) || has_key?(method.to_sym)
-      end
-    end
-
     ##
     # Expose the internal hash
     # @return [Hash]
@@ -133,8 +107,6 @@ module Blacklight
     def []=(key, value)
       if value.is_a? Hash
         send "#{key}=", nested_class.new(value)
-      elsif ::RUBY_VERSION < '2.0'
-        send "#{key}=", value
       else
         super
       end
@@ -181,21 +153,7 @@ module Blacklight
     # @return [OpenStructWithHashAccess] a new instance of an OpenStructWithHashAccess
     def merge! other_hash
       @table.merge!(nested_class, (other_hash if other_hash.is_a? Hash) || other_hash.to_h)
-    end
-
-    ##
-    # Override #method_missing from OpenStruct to ensure the default_proc logic
-    # gets triggered.
-    def method_missing(mid, *args)
-      len = args.length
-
-      if len == 0
-        new_ostruct_member(mid)
-        @table[mid]
-      else
-        super
-      end
-    end
+    end 
 
     private
     def set_default_proc!

data/lib/generators/blacklight/controller_generator.rb

@@ -29,10 +29,13 @@ module Blacklight
     end
 
     def inject_blacklight_routes
-      # These will end up in routes.rb file in reverse order
-      # we add em, since each is added at the top of file. 
-      # we want "root" to be FIRST for optimal url generation. 
-      route("blacklight_for :#{controller_name}")
+      route <<-EOF
+        concern :searchable, Blacklight::Routes::Searchable.new
+
+        resource :catalog, only: [:index], as: 'catalog', path: '/catalog', controller: 'catalog' do
+          concerns :searchable
+        end
+      EOF
     end
   end
 end

data/lib/generators/blacklight/install_generator.rb

@@ -16,10 +16,11 @@ module Blacklight
   This generator makes the following changes to your application:
    1. Generates blacklight:models
    2. Adds rsolr to the Gemfile
-   3. Creates a number of public assets, including images, stylesheets, and javascript
-   4. Injects behavior into your user application_controller.rb
-   5. Adds example configurations for dealing with MARC-like data
-   6. Adds Blacklight routes to your ./config/routes.rb
+   3. Adds globalid to the Gemfile
+   4. Creates a number of public assets, including images, stylesheets, and javascript
+   5. Injects behavior into your user application_controller.rb
+   6. Adds example configurations for dealing with MARC-like data
+   7. Adds Blacklight routes to your ./config/routes.rb
 
   Thank you for Installing Blacklight.
          """
@@ -36,7 +37,11 @@ module Blacklight
     end
 
     def add_rsolr_gem
-      gem "rsolr", "~> 1.0"
+      gem "rsolr", "~> 1.0.6"
+    end
+
+    def add_globalid_gem
+      gem "globalid"
     end
 
     def bundle_install
@@ -96,10 +101,6 @@ EOF
       copy_file "blacklight.en.yml", "config/locales/blacklight.en.yml"
     end
 
-    def add_blacklight_initializer
-      template "config/initializers/blacklight_initializer.rb"
-    end
-
     def generate_blacklight_marc_demo
       if options[:marc]
         gem "blacklight-marc", "~> 5.0"
@@ -111,5 +112,11 @@ EOF
         generate 'blacklight:marc:install'
       end
     end
+
+    def add_routes
+      route <<-EOF
+        mount Blacklight::Engine => '/'
+      EOF
+    end
   end
 end

data/lib/generators/blacklight/models_generator.rb

@@ -23,6 +23,24 @@ This generator makes the following changes to your application:
       rake "blacklight:install:migrations"
     end
 
+    def add_routes
+      route <<-EOF
+        concern :exportable, Blacklight::Routes::Exportable.new
+
+        resources :solr_documents, only: [:show], path: '/catalog', controller: 'catalog' do
+          concerns :exportable
+        end
+
+        resources :bookmarks do
+          concerns :exportable
+
+          collection do
+            delete 'clear'
+          end
+        end
+      EOF
+    end
+
 
   end
 end

data/lib/generators/blacklight/templates/catalog_controller.rb

@@ -1,27 +1,17 @@
 # -*- encoding : utf-8 -*-
-class <%= controller_name.classify %>Controller < ApplicationController  
+class <%= controller_name.classify %>Controller < ApplicationController
 
   include Blacklight::Catalog
 
   configure_blacklight do |config|
-    ## Class for sending and receiving requests from a search index
-    # config.repository_class = Blacklight::Solr::Repository
-    #
-    ## Class for converting Blacklight's url parameters to into request parameters for the search index
-    # config.search_builder_class = ::SearchBuilder
-    #
-    ## Model that maps search index responses to the blacklight response model
-    # config.response_model = Blacklight::Solr::Response
-
     ## Default parameters to send to solr for all search-like requests. See also SearchBuilder#processed_parameters
-    config.default_solr_params = { 
-      :qt => 'search',
-      :rows => 10 
+    config.default_solr_params = {
+      rows: 10
     }
-    
+
     # solr path which will be added to solr base url before the other solr params.
-    #config.solr_path = 'select' 
-    
+    #config.solr_path = 'select'
+
     # items to show per page, each number in the array represent another option to choose from.
     #config.per_page = [10,20,50,100]
 
@@ -29,11 +19,11 @@ class <%= controller_name.classify %>Controller < ApplicationController
     ## parameters included in the Blacklight-jetty document requestHandler.
     #
     #config.default_document_solr_params = {
-    #  :qt => 'document',
+    #  qt: 'document',
     #  ## These are hard-coded in the blacklight 'document' requestHandler
-    #  # :fl => '*',
-    #  # :rows => 1
-    #  # :q => '{!raw f=id v=$id}' 
+    #  # fl: '*',
+    #  # rows: 1
+    #  # q: '{!term f=id v=$id}'
     #}
 
     # solr field configuration for search results/index views
@@ -51,32 +41,37 @@ class <%= controller_name.classify %>Controller < ApplicationController
     # * If left unset, then all facet values returned by solr will be displayed.
     # * If set to an integer, then "f.somefield.facet.limit" will be added to
     # solr request, with actual solr request being +1 your configured limit --
-    # you configure the number of items you actually want _displayed_ in a page.    
+    # you configure the number of items you actually want _displayed_ in a page.
     # * If set to 'true', then no additional parameters will be sent to solr,
     # but any 'sniffed' request limit parameters will be used for paging, with
-    # paging at requested limit -1. Can sniff from facet.limit or 
+    # paging at requested limit -1. Can sniff from facet.limit or
     # f.specific_field.facet.limit solr request params. This 'true' config
     # can be used if you set limits in :default_solr_params, or as defaults
     # on the solr side in the request handler itself. Request handler defaults
     # sniffing requires solr requests to be made with "echoParams=all", for
-    # app code to actually have it echo'd back to see it.  
+    # app code to actually have it echo'd back to see it.
     #
-    # :show may be set to false if you don't want the facet to be drawn in the 
+    # :show may be set to false if you don't want the facet to be drawn in the
     # facet bar
-    config.add_facet_field 'format', :label => 'Format'
-    config.add_facet_field 'pub_date', :label => 'Publication Year', :single => true
-    config.add_facet_field 'subject_topic_facet', :label => 'Topic', :limit => 20 
-    config.add_facet_field 'language_facet', :label => 'Language', :limit => true 
-    config.add_facet_field 'lc_1letter_facet', :label => 'Call Number' 
-    config.add_facet_field 'subject_geo_facet', :label => 'Region' 
-    config.add_facet_field 'subject_era_facet', :label => 'Era'  
-
-    config.add_facet_field 'example_pivot_field', :label => 'Pivot Field', :pivot => ['format', 'language_facet']
-
-    config.add_facet_field 'example_query_facet_field', :label => 'Publish Date', :query => {
-      :years_5 => { :label => 'within 5 Years', :fq => "pub_date:[#{Time.zone.now.year - 5 } TO *]" },
-      :years_10 => { :label => 'within 10 Years', :fq => "pub_date:[#{Time.zone.now.year - 10 } TO *]" },
-      :years_25 => { :label => 'within 25 Years', :fq => "pub_date:[#{Time.zone.now.year - 25 } TO *]" }
+    #
+    # set :index_range to true if you want the facet pagination view to have facet prefix-based navigation
+    #  (useful when user clicks "more" on a large facet and wants to navigate alphabetically across a large set of results)
+    # :index_range can be an array or range of prefixes that will be used to create the navigation (note: It is case sensitive when searching values)
+
+    config.add_facet_field 'format', label: 'Format'
+    config.add_facet_field 'pub_date', label: 'Publication Year', single: true
+    config.add_facet_field 'subject_topic_facet', label: 'Topic', limit: 20, index_range: 'A'..'Z'
+    config.add_facet_field 'language_facet', label: 'Language', limit: true
+    config.add_facet_field 'lc_1letter_facet', label: 'Call Number'
+    config.add_facet_field 'subject_geo_facet', label: 'Region'
+    config.add_facet_field 'subject_era_facet', label: 'Era'
+
+    config.add_facet_field 'example_pivot_field', label: 'Pivot Field', :pivot => ['format', 'language_facet']
+
+    config.add_facet_field 'example_query_facet_field', label: 'Publish Date', :query => {
+       :years_5 => { label: 'within 5 Years', fq: "pub_date:[#{Time.now.year - 5 } TO *]" },
+       :years_10 => { label: 'within 10 Years', fq: "pub_date:[#{Time.now.year - 10 } TO *]" },
+       :years_25 => { label: 'within 25 Years', fq: "pub_date:[#{Time.now.year - 25 } TO *]" }
     }
 
 
@@ -86,33 +81,33 @@ class <%= controller_name.classify %>Controller < ApplicationController
     config.add_facet_fields_to_solr_request!
 
     # solr fields to be displayed in the index (search results) view
-    #   The ordering of the field names is the order of the display 
-    config.add_index_field 'title_display', :label => 'Title'
-    config.add_index_field 'title_vern_display', :label => 'Title'
-    config.add_index_field 'author_display', :label => 'Author'
-    config.add_index_field 'author_vern_display', :label => 'Author'
-    config.add_index_field 'format', :label => 'Format'
-    config.add_index_field 'language_facet', :label => 'Language'
-    config.add_index_field 'published_display', :label => 'Published'
-    config.add_index_field 'published_vern_display', :label => 'Published'
-    config.add_index_field 'lc_callnum_display', :label => 'Call number'
+    #   The ordering of the field names is the order of the display
+    config.add_index_field 'title_display', label: 'Title'
+    config.add_index_field 'title_vern_display', label: 'Title'
+    config.add_index_field 'author_display', label: 'Author'
+    config.add_index_field 'author_vern_display', label: 'Author'
+    config.add_index_field 'format', label: 'Format'
+    config.add_index_field 'language_facet', label: 'Language'
+    config.add_index_field 'published_display', label: 'Published'
+    config.add_index_field 'published_vern_display', label: 'Published'
+    config.add_index_field 'lc_callnum_display', label: 'Call number'
 
     # solr fields to be displayed in the show (single result) view
-    #   The ordering of the field names is the order of the display 
-    config.add_show_field 'title_display', :label => 'Title'
-    config.add_show_field 'title_vern_display', :label => 'Title'
-    config.add_show_field 'subtitle_display', :label => 'Subtitle'
-    config.add_show_field 'subtitle_vern_display', :label => 'Subtitle'
-    config.add_show_field 'author_display', :label => 'Author'
-    config.add_show_field 'author_vern_display', :label => 'Author'
-    config.add_show_field 'format', :label => 'Format'
-    config.add_show_field 'url_fulltext_display', :label => 'URL'
-    config.add_show_field 'url_suppl_display', :label => 'More Information'
-    config.add_show_field 'language_facet', :label => 'Language'
-    config.add_show_field 'published_display', :label => 'Published'
-    config.add_show_field 'published_vern_display', :label => 'Published'
-    config.add_show_field 'lc_callnum_display', :label => 'Call number'
-    config.add_show_field 'isbn_t', :label => 'ISBN'
+    #   The ordering of the field names is the order of the display
+    config.add_show_field 'title_display', label: 'Title'
+    config.add_show_field 'title_vern_display', label: 'Title'
+    config.add_show_field 'subtitle_display', label: 'Subtitle'
+    config.add_show_field 'subtitle_vern_display', label: 'Subtitle'
+    config.add_show_field 'author_display', label: 'Author'
+    config.add_show_field 'author_vern_display', label: 'Author'
+    config.add_show_field 'format', label: 'Format'
+    config.add_show_field 'url_fulltext_display', label: 'URL'
+    config.add_show_field 'url_suppl_display', label: 'More Information'
+    config.add_show_field 'language_facet', label: 'Language'
+    config.add_show_field 'published_display', label: 'Published'
+    config.add_show_field 'published_vern_display', label: 'Published'
+    config.add_show_field 'lc_callnum_display', label: 'Call number'
+    config.add_show_field 'isbn_t', label: 'ISBN'
 
     # "fielded" search configuration. Used by pulldown among other places.
     # For supported keys in hash, see rdoc for Blacklight::SearchFields
@@ -126,50 +121,50 @@ class <%= controller_name.classify %>Controller < ApplicationController
     # The :key is what will be used to identify this BL search field internally,
     # as well as in URLs -- so changing it after deployment may break bookmarked
     # urls.  A display label will be automatically calculated from the :key,
-    # or can be specified manually to be different. 
+    # or can be specified manually to be different.
 
     # This one uses all the defaults set by the solr request handler. Which
     # solr request handler? The one set in config[:default_solr_parameters][:qt],
-    # since we aren't specifying it otherwise. 
-    
-    config.add_search_field 'all_fields', :label => 'All Fields'
-    
+    # since we aren't specifying it otherwise.
+
+    config.add_search_field 'all_fields', label: 'All Fields'
+
 
     # Now we see how to over-ride Solr request handler defaults, in this
     # case for a BL "search field", which is really a dismax aggregate
-    # of Solr search fields. 
-    
+    # of Solr search fields.
+
     config.add_search_field('title') do |field|
-      # solr_parameters hash are sent to Solr as ordinary url query params. 
+      # solr_parameters hash are sent to Solr as ordinary url query params.
       field.solr_parameters = { :'spellcheck.dictionary' => 'title' }
 
       # :solr_local_parameters will be sent using Solr LocalParams
       # syntax, as eg {! qf=$title_qf }. This is neccesary to use
       # Solr parameter de-referencing like $title_qf.
       # See: http://wiki.apache.org/solr/LocalParams
-      field.solr_local_parameters = { 
-        :qf => '$title_qf',
-        :pf => '$title_pf'
+      field.solr_local_parameters = {
+        qf: '$title_qf',
+        pf: '$title_pf'
       }
     end
-    
+
     config.add_search_field('author') do |field|
       field.solr_parameters = { :'spellcheck.dictionary' => 'author' }
-      field.solr_local_parameters = { 
-        :qf => '$author_qf',
-        :pf => '$author_pf'
+      field.solr_local_parameters = {
+        qf: '$author_qf',
+        pf: '$author_pf'
       }
     end
-    
+
     # Specifying a :qt only to show it's possible, and so our internal automated
-    # tests can test it. In this case it's the same as 
-    # config[:default_solr_parameters][:qt], so isn't actually neccesary. 
+    # tests can test it. In this case it's the same as
+    # config[:default_solr_parameters][:qt], so isn't actually neccesary.
     config.add_search_field('subject') do |field|
       field.solr_parameters = { :'spellcheck.dictionary' => 'subject' }
       field.qt = 'search'
-      field.solr_local_parameters = { 
-        :qf => '$subject_qf',
-        :pf => '$subject_pf'
+      field.solr_local_parameters = {
+        qf: '$subject_qf',
+        pf: '$subject_pf'
       }
     end
 
@@ -177,14 +172,13 @@ class <%= controller_name.classify %>Controller < ApplicationController
     # label in pulldown is followed by the name of the SOLR field to sort by and
     # whether the sort is ascending or descending (it must be asc or desc
     # except in the relevancy case).
-    config.add_sort_field 'score desc, pub_date_sort desc, title_sort asc', :label => 'relevance'
-    config.add_sort_field 'pub_date_sort desc, title_sort asc', :label => 'year'
-    config.add_sort_field 'author_sort asc, title_sort asc', :label => 'author'
-    config.add_sort_field 'title_sort asc, pub_date_sort desc', :label => 'title'
+    config.add_sort_field 'score desc, pub_date_sort desc, title_sort asc', label: 'relevance'
+    config.add_sort_field 'pub_date_sort desc, title_sort asc', label: 'year'
+    config.add_sort_field 'author_sort asc, title_sort asc', label: 'author'
+    config.add_sort_field 'title_sort asc, pub_date_sort desc', label: 'title'
 
-    # If there are more than this many search results, no spelling ("did you 
+    # If there are more than this many search results, no spelling ("did you
     # mean") suggestion is offered.
     config.spell_max = 5
   end
-
-end 
+end