blacklight 5.0.0.pre3 → 5.0.0.pre4

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

@@ -11,7 +11,7 @@
   <div id="doc_<%= @document.id.to_s.parameterize %>">
   
     <% # bookmark/folder functions -%>
-    <%= render_document_partials @document, blacklight_config.show.partials %>
+    <%= render_document_partials @document, blacklight_config.view_config(:show).partials %>
  
   </div>
 </div>

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

@@ -1,5 +1,5 @@
 <div class="modal-header">
-	<button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
+	<button type="button" class="ajax-modal-close close" data-dismiss="modal" aria-hidden="true">×</button>
 	<h1 class="modal-title"><%= t('blacklight.sms.form.title') %></h1>
 </div>
 <%= render :partial => 'sms_form' %>

data/blacklight.gemspec

@@ -26,8 +26,8 @@ Gem::Specification.new do |s|
   s.add_dependency "sass-rails"
   s.add_dependency "bootstrap-sass", "~> 3.0"
   s.add_dependency "deprecation"
-  s.add_development_dependency "jettywrapper", ">= 1.4.1"
-  s.add_development_dependency "blacklight_marc", "0.0.6"
+  s.add_development_dependency "jettywrapper", ">= 1.5.2"
+  s.add_development_dependency "blacklight_marc", "0.0.9"
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency 'engine_cart', ">= 0.1.0"
   s.add_development_dependency "equivalent-xml"

data/config/jetty.yml

@@ -1,4 +1,7 @@
-default:
+development:
   startup_wait: 15
+  jetty_port: 8983 
+test:
+  startup_wait: 60
   jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8888 %> 
   <%= ENV['TEST_JETTY_PATH'] ? "jetty_home: " + ENV['TEST_JETTY_PATH'] : '' %>

data/config/locales/blacklight.en.yml

@@ -191,8 +191,11 @@ en:
           value: 'Remove constraint %{value}'
           label_value: 'Remove constraint %{label}: %{value}'
       start_over: 'Start Over'
+      index:
+        label: '%{label}:'
       show:
         title: '%{document_title} - %{application_name}'
+        label: '%{label}:'
       rss_feed: 'RSS for results'
       atom_feed: 'Atom for results'
       fields:

data/config/locales/blacklight.fr.yml

@@ -207,8 +207,11 @@ fr:
           value: 'Supprimer la restriction %{value}'
           label_value: 'Supprimer la restriction %{label}: %{value}'
       start_over: 'Accueil'
+      index:
+        label: '%{label}:'
       show:
         title: '%{document_title} - %{application_name}'
+        label: '%{label}:'
       rss_feed: 'RSS pour les résultats'
       atom_feed: 'Atom pour les résultats'
       fields:

data/{lib/generators/blacklight/templates/migrations/create_searches.rb → db/migrate/20140202020201_create_searches.rb}

@@ -4,9 +4,11 @@ class CreateSearches < ActiveRecord::Migration
     create_table :searches do |t|
       t.text  :query_params
       t.integer :user_id
+      t.string :user_type
 
       t.timestamps
     end
+
     add_index :searches, :user_id
   end
 

data/{lib/generators/blacklight/templates/migrations/create_bookmarks.rb → db/migrate/20140202020202_create_bookmarks.rb}

@@ -3,10 +3,9 @@ class CreateBookmarks < ActiveRecord::Migration
   def self.up
     create_table :bookmarks do |t|
       t.integer :user_id, :null=>false
-      t.text :url
+      t.string :user_type
       t.string :document_id
       t.string :title
-      t.text :notes
       t.timestamps
     end
   end

data/gemfiles/rails3.gemfile

@@ -8,6 +8,8 @@ gem 'rails', "~> 3.2"
 gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 
 group :test do
+  gem 'simplecov', require: false
+  gem 'coveralls', require: false
   gem 'devise'
   gem 'devise-guests'
   gem "bootstrap-sass"

data/gemfiles/rails4.gemfile

@@ -8,6 +8,8 @@ gem 'rails', '~> 4.0.0'
 gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
 
 group :test do
+  gem 'simplecov', require: false
+  gem 'coveralls', require: false
   gem 'devise'
   gem 'devise-guests'
   gem "bootstrap-sass"

data/lib/blacklight.rb

@@ -1,7 +1,6 @@
 # -*- encoding : utf-8 -*-
 require 'kaminari'
 require 'rsolr'
-
 module Blacklight
 
   autoload :Configurable, 'blacklight/configurable'
@@ -34,11 +33,6 @@ module Blacklight
   class << self
     attr_accessor :solr, :solr_config
   end
-  
-  # Adding a little jruby support
-  def self.jruby?
-    defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby" 
-  end
 
   def self.solr_file
     "#{::Rails.root.to_s}/config/solr.yml"
@@ -65,7 +59,7 @@ module Blacklight
 
     return @solr_yml if @solr_yml
     unless File.exists?(solr_file)
-      raise "You are missing a solr configuration file: #{solr_file}. Have you run \"rails generate blacklight\"?"  
+      raise "You are missing a solr configuration file: #{solr_file}. Have you run \"rails generate blacklight:install\"?"  
     end
 
     begin
@@ -103,38 +97,5 @@ module Blacklight
   def self.root
     @root ||= File.expand_path(File.dirname(File.dirname(__FILE__)))
   end
-
-  # This is useful for modifying Blacklight models.
-  # In the main app you can then do this:
-  # require "#{MyEngine.models_dir}/bookmark"
-  # class Bookmark
-  # ...
-  # end
-  # BE AWARE - When you do this, you are monkey patching Blacklight
-  # we should eventually find a better way - such as the acts_as pattern
-  def self.models_dir
-    "#{root}/app/models"
-  end
-  
-  def self.controllers_dir
-    "#{root}/app/controllers"
-  end
-
-  
-  # Searches Rails.root then Blacklight.root for a valid path
-  # returns a full path if a valid path is found
-  # returns nil if nothing is found.
-  # First looks in Rails.root, then Blacklight.root
-  #
-  # Example:
-  # full_path_to_solr_marc_jar = Blacklight.locate_path 'solr_marc', 'SolrMarc.jar'
-  
-  def self.locate_path(*subpath_fragments)
-    subpath = subpath_fragments.join('/')
-    base_match = [Rails.root, self.root].find do |base|
-      File.exists? File.join(base, subpath)
-    end
-    File.join(base_match.to_s, subpath) if base_match
-  end
   
 end

data/lib/blacklight/base.rb

@@ -5,6 +5,8 @@ module Blacklight::Base
   include Blacklight::Configurable
   include Blacklight::SolrHelper
 
+  require 'blacklight/catalog/search_context'
+  include Blacklight::Catalog::SearchContext
 
   included do  
     # When RSolr::RequestError is raised, the rsolr_request_error method is executed.
@@ -37,12 +39,4 @@ module Blacklight::Base
       redirect_to root_path
     end
   end
-
-  def blacklight_solr
-    @solr ||=  RSolr.connect(blacklight_solr_config)
-  end
-
-  def blacklight_solr_config
-    Blacklight.solr_config
-  end
-end
+end

data/lib/blacklight/catalog.rb

@@ -3,9 +3,6 @@ module Blacklight::Catalog
   extend ActiveSupport::Concern
   
   include Blacklight::Base
-  
-  require 'blacklight/catalog/search_context'
-  include Blacklight::Catalog::SearchContext
 
   SearchHistoryWindow = 100 # how many searches to save in session history
 
@@ -98,13 +95,7 @@ module Blacklight::Catalog
         format.js { render :layout => false }
       end
     end
-    # grabs a bunch of documents to export to endnote
-    def endnote
-      @response, @documents = get_solr_response_for_field_values(SolrDocument.unique_key,params[:id])
-      respond_to do |format|
-        format.endnote { render :layout => false }
-      end
-    end
+
     
     # Email Action (this will render the appropriate view on GET requests and process the form and send the email on POST requests)
     def email
@@ -242,11 +233,7 @@ module Blacklight::Catalog
       render "index", :status => 404
     end
 
-    def blacklight_solr
-      @solr ||=  RSolr.connect(blacklight_solr_config)
-    end
-
-    def blacklight_solr_config
-      Blacklight.solr_config
+    def start_new_search_session?
+      action_name == "index"
     end
 end

data/lib/blacklight/catalog/search_context.rb

@@ -26,7 +26,7 @@ module Blacklight::Catalog::SearchContext
   # The current search session 
   def current_search_session
 
-    @current_search_session ||= if action_name == "index"
+    @current_search_session ||= if start_new_search_session?
       find_or_initialize_search_session_from_params params
     elsif params[:search_context].present?
       find_or_initialize_search_session_from_params JSON.load(params[:search_context])
@@ -50,6 +50,13 @@ module Blacklight::Catalog::SearchContext
     @current_search_session
   end
 
+  ##
+  # If the current action should start a new search session, this should be
+  # set to true
+  def start_new_search_session?
+    false
+  end
+
   def find_or_initialize_search_session_from_params params
     params_copy = params.reject { |k,v| blacklisted_search_session_params.include?(k.to_sym) or v.blank? }
 

data/lib/blacklight/configurable.rb

@@ -41,8 +41,7 @@ module Blacklight::Configurable
     end
 
     ##
-    # The default configuration object, by default it reads from Blacklight.config for backwards
-    # compatibility with Blacklight <= 3.1
+    # The default configuration object
     def default_configuration
       Blacklight::Configurable.default_configuration.inheritable_copy
     end

data/lib/blacklight/configuration.rb

@@ -4,6 +4,8 @@ module Blacklight
   # fields to display, facets to show, sort options, and search fields.
   class Configuration < OpenStructWithHashAccess
 
+    require 'blacklight/configuration/view_config'
+
     # Set up Blacklight::Configuration.default_values to contain
     # the basic, required Blacklight fields
     class << self
@@ -17,13 +19,13 @@ module Blacklight
           :default_solr_params => {},
           :document_solr_request_handler => nil,
           :default_document_solr_params => {},
-          :show => OpenStructWithHashAccess.new(:partials => [:show_header, :show], :html_title => unique_key, :heading => unique_key),
-          :index => OpenStructWithHashAccess.new(:partials => [:index_header, :thumbnail, :index], :show_link => unique_key, :record_display_type => 'format', :group => false),
+          :show => ViewConfig::Show.new(:partials => [:show_header, :show]),
+          :index => ViewConfig::Index.new(:partials => [:index_header, :thumbnail, :index], :title_field => unique_key, :display_type_field => 'format', :group => false),
+          :view => NestedOpenStructWithHashAccess.new(ViewConfig, 'list'),
           :spell_max => 5,
           :max_per_page => 100,
           :per_page => [10,20,50,100],
           :search_history_window => Blacklight::Catalog::SearchHistoryWindow,
-          :document_index_view_types => ['list'],
           :add_facet_fields_to_solr_request => false,
           :add_field_configuration_to_solr_request => false,
           :http_method => :get
@@ -114,5 +116,13 @@ module Blacklight
       yield self if block_given?
       self
     end
+
+    def view_config view_type
+      if view_type == :show
+        self.index.merge self.show
+      else
+        self.index.merge view.fetch(view_type, {})
+      end
+    end
   end
 end

data/lib/blacklight/configuration/view_config.rb

@@ -0,0 +1,71 @@
+require 'deprecation'
+
+class Blacklight::Configuration
+  class ViewConfig < Blacklight::OpenStructWithHashAccess
+    class Show < ViewConfig
+      extend Deprecation
+      self.deprecation_horizon = 'blacklight 6.0'
+
+      def html_title
+        Deprecation.warn(self.class, "config.show.html_title is deprecated; use config.show.title_field instead")
+        fetch(:html_title, title_field)
+      end
+
+      def heading
+        Deprecation.warn(self.class, "config.show.heading is deprecated; use config.show.title_field instead")
+        fetch(:heading, title_field)
+      end
+
+      def display_type
+        Deprecation.warn(self.class, "config.show.display_type is deprecated; use config.show.display_type_field instead")
+        fetch(:display_type, display_type_field)
+      end
+
+      def html_title= value
+        Deprecation.warn(self.class, "config.show.html_title is deprecated; use config.show.title_field instead")
+        super value
+        self.title_field = value
+      end
+
+      def heading= value
+        Deprecation.warn(self.class, "config.show.heading is deprecated; use config.show.title_field instead")
+        super value
+        self.title_field = value
+      end
+
+      def display_type= value
+        Deprecation.warn(self.class, "config.show.display_type is deprecated; use config.show.display_type_field instead")
+        super value
+        self.display_type_field = value
+      end
+    end
+
+    class Index < ViewConfig
+      extend Deprecation
+      self.deprecation_horizon = 'blacklight 6.0'
+
+      def record_display_type
+        Deprecation.warn(self.class, "config.index.record_display_type is deprecated; use config.index.display_type_field instead")
+        fetch(:record_display_type, display_type_field)
+      end
+
+      def record_display_type= value
+        Deprecation.warn(self.class, "config.index.record_display_type is deprecated; use config.index.display_type_field instead")
+        super value
+        self.display_type_field = value
+      end
+
+      def show_link
+        Deprecation.warn(self.class, "config.index.show_link is deprecated; use config.index.title_field instead")   
+        fetch(:show_link, title_field)
+      end
+
+      def show_link= value
+        Deprecation.warn(self.class, "config.index.show_link is deprecated; use config.index.title_field instead")
+        super value
+        self.title_field = value
+      end
+
+    end
+  end
+end

data/lib/blacklight/engine.rb

@@ -1,5 +1,6 @@
 module Blacklight
   class Engine < Rails::Engine
+    engine_name "blacklight"
 
     require 'bootstrap-sass'
     require 'blacklight/rails/routes'

data/lib/blacklight/routes.rb

@@ -102,7 +102,6 @@ module Blacklight
           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
 

data/lib/blacklight/solr/document.rb

@@ -161,10 +161,6 @@ module Blacklight::Solr::Document
       @unique_key ||= 'id' 
     end
 
-     def connection
-      @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

data/lib/blacklight/solr_helper.rb

@@ -558,13 +558,12 @@ module Blacklight::SolrHelper
   end
     
   # returns a solr params hash
-  # if field is nil, the value is fetched from blacklight_config[:index][:show_link]
   # the :fl (solr param) is set to the "field" value.
   # per_page is set to 10
   def solr_opensearch_params(field=nil)
     solr_params = solr_search_params
     solr_params[:per_page] = 10
-    solr_params[:fl] = blacklight_config.index.show_link
+    solr_params[:fl] = field || blacklight_config.view_config('opensearch').title_field
     solr_params
   end
   
@@ -616,4 +615,11 @@ module Blacklight::SolrHelper
     blacklight_config.index.group
   end
 
+  def blacklight_solr
+    @solr ||=  RSolr.connect(blacklight_solr_config)
+  end
+
+  def blacklight_solr_config
+    Blacklight.solr_config
+  end
 end