blacklight 3.8.1 → 3.8.2

data/.travis.yml

@@ -0,0 +1,14 @@
+notifications:
+  email: false
+  
+rvm:
+  # - 1.8.7
+  - 1.9.3
+  # - rbx-2.0
+  # - jruby
+
+env:
+  - RAILS_VERISON=3.2.8
+
+script:
+  - test_support/bin/test.sh

data/VERSION

@@ -1 +1 @@
-3.8.1
+3.8.2

data/app/controllers/bookmarks_controller.rb

@@ -37,6 +37,8 @@ class BookmarksController < CatalogController
       @bookmarks << params[:bookmark] if params[:bookmark]
      end
 
+    current_or_guest_user.save! unless current_or_guest_user.persisted?
+
     success = @bookmarks.all? do |bookmark|
       current_or_guest_user.bookmarks.create(bookmark) unless current_or_guest_user.existing_bookmark_for(bookmark[:document_id])
     end

data/app/models/solr_document.rb

@@ -0,0 +1,5 @@
+class SolrDocument 
+
+  include Blacklight::Solr::Document
+
+end

data/app/views/_user_util_links.html.erb

@@ -6,7 +6,9 @@
 <% end %>
     | 
 <% end %>
+<% if current_or_guest_user %>
     <%= link_to t('blacklight.header_links.bookmarks'), bookmarks_path %>
+<% end %>
  <% if current_user %>
     |
     <%= link_to t('blacklight.header_links.saved_searches'), saved_searches_path %>

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

@@ -1,4 +1,4 @@
-<% if has_user_authentication_provider? and current_or_guest_user %>
+<% if current_or_guest_user %>
   <%- existing_bookmark = current_or_guest_user.existing_bookmark_for(document.id) -%>
   <%- 
   # Note these two forms are pretty similar but for different :methods, classes, and labels. 

data/doc/Atom-Responses.md

@@ -0,0 +1,90 @@
+Blacklight will provide atom responses for all catalog/index results. Just add ".atom" on to the end of your path component, `/catalog.atom`, or `/catalog/index.atom`. 
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" xmlns="http://www.w3.org/2005/Atom">
+  <title>Blacklight Search Results</title>
+  <author>
+    <name>Blacklight</name>
+  </author>
+  <link href="http://demo.projectblacklight.org/?commit=search&amp;amp;format=atom&amp;amp;q=urdu&amp;amp;search_field=all_fields" rel="self"/>
+  <link href="http://demo.projectblacklight.org/?commit=search&amp;amp;format=html&amp;amp;q=urdu&amp;amp;search_field=all_fields" rel="alternate" type="text/html"/>
+  <id>http://demo.projectblacklight.org/?commit=search&amp;amp;format=html&amp;amp;q=urdu&amp;amp;search_field=all_fields&amp;amp;type=text%2Fhtml</id>
+  <link href="http://demo.projectblacklight.org/?commit=search&amp;amp;format=atom&amp;amp;page=2&amp;amp;q=urdu&amp;amp;search_field=all_fields" rel="next"/>
+  <link href="http://demo.projectblacklight.org/?commit=search&amp;amp;format=atom&amp;amp;page=1&amp;amp;q=urdu&amp;amp;search_field=all_fields" rel="first"/>
+  <link href="http://demo.projectblacklight.org/?commit=search&amp;amp;format=atom&amp;amp;page=15&amp;amp;q=urdu&amp;amp;search_field=all_fields" rel="last"/>
+  <link href="http://demo.projectblacklight.org/catalog/opensearch.xml" rel="search" type="application/opensearchdescription+xml"/>
+  <opensearch:totalResults>147</opensearch:totalResults>
+  <opensearch:startIndex>0</opensearch:startIndex>
+  <opensearch:itemsPerPage>10</opensearch:itemsPerPage>
+  <opensearch:Query searchTerms="urdu" startPage="1" role="request"/>
+  <updated>2011-05-11T17:46:58Z</updated>
+  <entry>
+    <title>Urdu&#772; d&#803;ra&#772;ma&#772;</title>
+    <updated>2011-05-11T17:46:58Z</updated>
+    <link href="http://demo.projectblacklight.org/catalog/2008306442" rel="alternate" type="text/html"/>
+<link href="http://demo.projectblacklight.org/catalog/2008306442.dc_xml" rel="alternate" title="dc_xml" type="text/xml" />
+<link href="http://demo.projectblacklight.org/catalog/2008306442.xml" rel="alternate" title="xml" type="application/xml" />
+    <id>http://demo.projectblacklight.org/catalog/2008306442</id>
+    <author>
+      <name>Farg&#818;h&#818;a&#772;nah, 1979-</name>
+    </author>
+    <summary type="html">
+&lt;dl class="defList"&gt;
+  
+      
+        &lt;dt class="blacklight-title_display"&gt;Title:&lt;/dt&gt;
+        &lt;dd class="blacklight-title_display"&gt;Urdu&#772; d&#803;ra&#772;ma&#772;&lt;/dd&gt;
+                
+        &lt;dt class="blacklight-author_display"&gt;Author:&lt;/dt&gt;
+        &lt;dd class="blacklight-author_display"&gt;Farg&#818;h&#818;a&#772;nah, 1979-&lt;/dd&gt;
+                
+        
+<!-- [...] -->
+&lt;/dl&gt;
+    </summary>
+  </entry>
+<!-- [...] -->
+</feed>
+```
+
+
+The same HTML summary included in your HTML results pages are included as an `atom:summary` element -- the atom template uses the `[[#render_document_partial|https://github.com/projectblacklight/blacklight/blob/master/app/helpers/blacklight/blacklight_helper_behavior.rb#L203]]` helper method to generate this HTML summary, so if you've over-ridden that for your app, it will be used as the  `atom:summary` content instead.
+
+## API Usage
+The Atom response is intended to be pretty full of data, so it can fill many traditional API requests.  It makes use of every relevant atom or [[OpenSearch|http://www.opensearch.org/Home]] element that could be conveniently included. 
+
+The Atom response also supports arbitrary format representations in the `atom:content` element.  You can include `&content_format=some_format` in your request URL (e.g. `[[/catalog.atom?content_format=oai_dc_xml|http://demo.projectblacklight.org/catalog.atom?q=urdu&content_format=oai_dc_xml]]`). Any format a given document can be exported as using the [[Blacklight document framework|Extending-blacklight-with-the-document-extension-framework]]  is available. Not every document can export in every format -- if a format is requested one or more of the items in your atom result can not export as, it will not have an `atom:content` element.  Non-XML-based formats are supported, as the content is Base64-encoded (as per Atom spec, unless the format is `text/plain`). 
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" xmlns="http://www.w3.org/2005/Atom">
+  <title>Blacklight Search Results</title>
+  <author>
+    <name>Blacklight</name>
+  </author>
+  <link href="http://demo.projectblacklight.org/?content_format=oai_dc_xml&amp;amp;format=atom&amp;amp;per_page=1" rel="self"/>
+<!-- [...] -->
+  <entry>
+    <title>The book of the dance in the 20th century selections from the Jane Bourne Parton collection of books on the dance</title>
+    <updated>2011-05-11T17:59:32Z</updated>
+    <link href="http://demo.projectblacklight.org/catalog/u1" rel="alternate" type="text/html"/>
+<link href="http://demo.projectblacklight.org/catalog/u1.dc_xml" rel="alternate" title="dc_xml" type="text/xml" />
+<link href="http://demo.projectblacklight.org/catalog/u1.xml" rel="alternate" title="xml" type="application/xml" />
+    <id>http://demo.projectblacklight.org/catalog/u1</id>
+    <author>
+      <name>Roatcap, Adela Spindler</name>
+    </author>
+    <summary type="html">
+<!-- [...] -->
+    </summary>
+<!-- [ Here is the export format as OAI Dublin Core XML ] -->
+    <content type="text/xml">
+<oai_dc:dc xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd" xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><dc:language>English</dc:language><dc:title>The book of the dance in the 20th century selections from the Jane Bourne Parton collection of books on the dance</dc:title><dc:format>Book</dc:format></oai_dc:dc>    </content>
+  </entry>
+</feed>
+```
+
+This means that if you add on a document extension that provides more export formats for some or all of your documents, that will automatically be available in the atom response. 
+
+If you choose to use the [[Blacklight CQL add-on|https://github.com/projectblacklight/blacklight_cql]], the combination of [[CQL|http://www.loc.gov/standards/sru/specs/cql.html]]  requests and Atom responses provides a pretty good more-or-less standards-based API to search results through Blacklight. 
+
+The Atom response generating template is at `app/views/catalog/index.builder.atom`.

data/doc/Blacklight-3.2-Release-Notes-and-Upgrade-Guide.md

@@ -0,0 +1,191 @@
+## Overview
+
+Blacklight 3.2 introduces a number of new features to Blacklight, including the Rails asset pipeline, a configuration refactor, and support for Solr 3.x by default.
+
+### Upgrading to Rails 3.1
+
+If you are still using Rails 3.0, you should first update your project to work with Rails 3.1. Start by fixing any Rails 3.0 deprecation warnings (as those features may no longer exist or fail silently in Rails 3.1). There are some good resources to help you with the upgrade (e.g. [[http://railscasts.com/episodes/282-upgrading-to-rails-3-1?view=asciicast]]). 
+
+### Assets (CODEBASE-363)
+Blacklight 3.2 uses the Rails 3.1 asset pipeline for all assets, stylesheets and javascript. The CSS has been refactored and now uses SCSS to enable easy changing of some common parameters/colors. In addition, it no longer uses YUI-grids CSS framework. (Instead it uses Susy grid css framework).
+
+What does this mean for you?
+
+* Small (hopefully) upgrade costs.
+
+* Use of the asset pipeline to compress and streamline all css files into one.
+
+* Easier theming of blacklight.
+
+After having upgraded to BL 3.2 (and Rails 3.1), the first thing you should do is upgrade to use the asset pipeline. The Blacklight gem's standard behavior for including CSS and Javascript in your app **requires the asset pipeline**. (Of course, if you don't  use the CSS or Javascript distributed with Blacklight, or want to roll your own custom way to include it, you could choose to continue without using the asset pipeline) 
+
+Run the Blacklight generator to upgrade from Blacklight 3.1 to 3.2:
+```
+$ rails g blacklight
+```
+
+This should update the `application.css` and `application.js` files with references to the new Blacklight assets. You will still need to move or update your local assets and customizations. 
+
+**Note**
+
+* Now, if you have  you will need to change your layout to use the new ids, look at: [app/views/layouts/blacklight.html.erb](https://github.com/projectblacklight/blacklight/blob/master/) for reference on the new tags (#page, #bd, #hd, #footer, #main, #main_container, #sidebar). The old yui tags have no meaning in the new css.
+
+* This also means that any local CSS that overrides Blacklight's CSS, if your uses the old yui-grids id's in your CSS selectors, you probably want to change them to use the new id's. (#doc, #doc2, etc,, as well as any .yui-*)
+
+* You will need to remove the line `require "yui"` from your `./app/assets/stylesheets/application.css`. In previous versions, Blacklight provided the YUI css library as part of the gem. In Blacklight 3.2, because the Blacklight is no longer using YUI, this has been removed. If you wish to continue using YUI, you will need to provide your own copy in your application. You can download the [Blacklight 3.1 YUI file](https://github.com/projectblacklight/blacklight/blob/release-3.1/app/assets/stylesheets/yui.css) or from the (Yahoo YUI site)[http://developer.yahoo.com/yui/2/].
+
+### Per-controller configuration (CODEBASE-365)
+
+In previous versions of Blacklight, configuring Blacklight was done using a global configuration hash called `Blacklight.config` (created in `config/initializers/blacklight_config.rb`). Blacklight 3.2 deprecates this global configuration in favor of a per-controller, DSL-style configuration. Support for the old-style configuration is  still available (meaning, if you do absolutely nothing, Blacklight will convert Blacklight.config into the new-style configuration, and your application will probably continue to work), but we strongly recommend applications switch to the new-style configuration.
+
+The two major changes are moving from the global configuration (`Blacklight.config`) to a Controller-specific method (`blacklight_config`) and replacing the hash-based access with an OpenStruct-based domain-specific language. The new style maintains many of the old semantics, but should be better structured and more clear.
+
+On your CatalogController, you can configure the Blacklight Catalog:
+
+```ruby
+class CatalogController < ApplicationController  
+
+  include Blacklight::Catalog
+
+  configure_blacklight do |config|
+    config.default_solr_params = { 
+      :qt => 'search',
+      :rows => 10 
+    }
+
+    # solr field configuration for search results/index views
+    config.index.show_link = 'title_display'
+    config.index.record_display_type = 'format'
+
+    # solr field configuration for document/show views
+    config.show.html_title = 'title_display'
+    config.show.heading = 'title_display'
+    config.show.display_type = 'format'
+
+  # ....
+  end
+
+# ...
+end
+
+```
+
+
+#### Creating a new configuration
+
+An example of the new style configuration is available at 
+[[https://github.com/projectblacklight/blacklight/blob/master/lib/generators/blacklight/templates/catalog_controller.rb]] and shows most of the ways one can use the new configuration.
+
+There are helper methods for adding field configuration (facets, index, and show fields) as well as search and sort fields. All of these methods accept a variety of inputs and should be used in local applications in whatever form is most clear.
+
+Field + configuration hash
+
+```ruby
+config.add_facet_field 'format', :label => 'Format' 
+```
+
+Configuration hash
+
+```ruby
+config.add_sort_field :sort => 'score desc, pub_date_sort desc, title_sort asc', :label => 'relevance'
+```
+
+Field + block
+
+```ruby
+    config.add_search_field('title') do |field|
+      # 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'
+      }
+    end
+```
+
+#### Using the new configuration
+
+Within a controller, the configuration can be accessed using the method `blacklight_config`, which is also exposed to helpers or views as a helper method.
+
+Outside of a controller context (which should be rare, and likely undesirable), the configuration is exposed at the class level as well, e.g.:
+
+```ruby
+CatalogController.blacklight_config
+```
+
+Some configuration-driven helper methods have also been moved to the configuration object:
+
+```ruby
+blacklight_config.default_search_field
+blacklight_config.default_sort_field
+blacklight_config.max_per_page 
+```
+
+The Blacklight field configuration are stored as ordered hashes, with a key corresponding to the field name:
+
+```ruby
+CatalogController.blacklight_config.facet_fields
+
+# {
+#     "format" => #<Blacklight::Configuration::FacetField:0x1025a0c78
+#        :label => "Format",
+#        :field => "format"
+#     >,
+#     "pub_date" => #<Blacklight::Configuration::FacetField:0x1025a7aa0
+#        :label => "Publication Year",
+#        :field => "pub_date"
+#    >,
+# ...
+```
+
+Values can be accessed using OpenStruct methods or as a Hash:
+ 
+```ruby
+CatalogController.blacklight_config.facet_fields["format"].label # == "Format"
+CatalogController.blacklight_config.facet_fields["format"][:label] # == "Format"
+```
+
+### Using the new-style config in local overrides
+If you have overriden views or helpers in your local application and access `Blacklight.config` directly, you will need to update your overrides. In general, you should be able to search for references to `Blacklight.config` in your local application, replace it with the controller-level method `blacklight_config` and possibly fix up some naming differences.
+
+### Facet refactor
+Facet helpers and views have been refactored to take advantage of the new configuration style and new features in Rails. 
+
+The old `_facet_limit` view has been split in two,
+
+* `_facet_limit` : the partial to display the facet values
+* `_facet_layout` : a 'partial layout' that displays the facet structure and headers
+
+In the facet configuration, you can specify the partial to use to render a facet:
+```ruby
+config.add_facet_field 'format', :label => 'Format', :partial => 'my_custom_format_facet_display_partial'
+``` 
+
+### Solr 3.5 (CODEBASE-345)
+Blacklight-jetty has been updated to Solr 3.5 (previously it was still Solr 1.4). Blacklight is still compatible with both Solr 1.x and 3.x, but the demo application is based on a Solr 3.x configuration.
+
+#### SolrMarc 2.3.1
+Older versions of SolrMarc were incompatible with Solr 3.x. Blacklight is now distributed with SolrMarc 2.3.1. But previous versions of Blacklight erroneously copied a SolrMarc.jar into your local app's lib/SolrMarc.jar when installing Blacklight. 
+
+If you have a previously installed Blacklight, unless you have intentionally installed a local compile of SolrMarc.jar, you should remove the file at local ./lib/SolrMarc.jar, so your app will use the latest version of SolrMarc shipped with Blacklight.
+
+
+
+### Other changes
+
+* [CODEBASE-325](http://jira.projectblacklight.org/jira/browse/CODEBASE-325) - Allow Blacklight to function correctly when no user authentication system is provided
+* [CODEBASE-362](http://jira.projectblacklight.org/jira/browse/CODEBASE-362) - Blacklight facets do not work with integer-type fields
+* [CODEBASE-367](http://jira.projectblacklight.org/jira/browse/CODEBASE-367) - Pull in Hydra's jettywrapper to manage jetty
+* [CODEBASE-369](http://jira.projectblacklight.org/jira/browse/CODEBASE-369) - Advanced Search has an incompatible character encoding issue under ruby 1.9
+* [CODEBASE-371](http://jira.projectblacklight.org/jira/browse/CODEBASE-371) - SolrHelper#get_solr_response_for_field_values does not adequately escape value lists
+* [CODEBASE-375](http://jira.projectblacklight.org/jira/browse/CODEBASE-375) - fix rake solr:marc:index task and generator to use distro SolrMarc.jar
+* [CODEBASE-376](http://jira.projectblacklight.org/jira/browse/CODEBASE-376) - Look at the did_you_mean.feature scenarios, review for accuracy.
+* [CODEBASE-377](http://jira.projectblacklight.org/jira/browse/CODEBASE-377) - Convert opensearch.xml.erb to true XML builder style
+* [CODEBASE-379](http://jira.projectblacklight.org/jira/browse/CODEBASE-379) - Factor out use of RSolr's pagination feature and use Solr's start/rows parameters instead
+* [CODEBASE-380](http://jira.projectblacklight.org/jira/browse/CODEBASE-380) - ActionMailer deprecations
+

data/doc/Blacklight-3.3-release-notes-and-upgrade-guide.md

@@ -0,0 +1,37 @@
+Issues: https://github.com/projectblacklight/blacklight/issues?milestone=2&state=open
+
+## Upgrade notes:
+
+Note: Please make sure to upgrade to at least Blacklight **3.3.1** to avoid problems with compiled assets in 3.3.0. 
+
+If you previously ran the blacklight 3.3.0 generator, after upgrading to 3.3.1: Edit your local `./app/assets/stylesheets/blacklight_themes/standard.css.scss` file, change the line (wrong) `@import 'blacklight/grids/susy';` to instead be (right) `@import 'blacklight/grids/susy_grid';`
+
+If you previously ran the blacklight 3.2.x or 3.3.0 generator, look in your local `./config/application.rb`, *remove* the line `config.sass.line_comments = Rails.env.development?` if present. 
+
+### Compass/susy upgrade
+
+[Compass](https://github.com/chriseppstein/compass) (our CSS framework) and [Susy](http://susy.oddbird.net/) have been updated to a new major release. This will necessitate some changes in installations already running BL 3.2.
+
+New installations should just use the generator as normal.
+
+Existing installations should do the following:
+
+**1.** In your gemfile, in `group :assets`, remove any reference to the compass gem, and add:
+
+    gem 'sass-rails', '~> 3.2.0'
+    gem 'compass-rails', '~> 1.0.0'
+    gem 'compass-susy-plugin', '~> 0.9.0'
+
+**2.** You can remove 'config/initializers/sass.rb'
+
+**3.** You must add, if you have not already: 'config/compass.rb'
+ 
+    require 'susy'
+    project_type = :rails
+
+**4.** Replace any references in your css:
+
+`@import "blacklight/grids/susy_framework"` with `@import "susy"`
+ 
+`@import "blacklight/grids/susy"` with `@import "blacklight/grids/susy_grid"` 
+

data/doc/Blacklight-3.4-release-notes-and-upgrade-guide.md

@@ -0,0 +1,27 @@
+# Blacklight 3.4 Release notes
+Blacklight 3.4.0 is now available. It fixes a number of bugs and
+tests, but also adds a handful of new features.
+
+ - Fixed Rails 3.1 compatibility for rspec tests
+ - changes to make Blacklight work better with arbitrary solr indexes.
+ - Use ERb to parse the solr.yml configuration (allowing environment
+variables to be referenced in the config)
+ - fixed #351, saving Selected Items (Folder) to Bookmarks
+(SavedRecords), more than 10.
+ - fixed #398 document fetching/config refactor, which elevates
+document-request solr parameters into the controller's
+blacklight_config.
+ - fixed #333, Blacklight should throw more helpful errors if it
+unable to connect to Solr
+ - fixed #96, supporting configurable request handler paths
+
+The full list of Github issues are at:
+https://github.com/projectblacklight/blacklight/issues?milestone=4&state=closed
+
+Also, the GitHub compare view of this release vs. our last release is
+located at:
+https://github.com/projectblacklight/blacklight/compare/v3.3.0...v3.4.0
+
+# Upgrade notes
+
+No known issues updating from 3.3 to 3.4.

data/doc/Blacklight-3.5-release-notes-and-upgrade-guide.md

@@ -0,0 +1,44 @@
+# Blacklight 3.5 Release Notes And Upgrade Guide
+
+## Release Notes
+# Blacklight 3.5 Release notes
+Blacklight 3.5.0 is now available. It introduces i18n support for Blacklight, allowing applications to change and modify Blacklight-provided text strings without the need to override partials (in addition to providing multi-lingual support).
+
+- Fix #395, removing hard-coded no-reply@ email addresses from the ```RecordMailer``` (see below for upgrade notes)
+- Consistent use of polymorphic routing to the show views for documents. ```solr_document_url``` and ```solr_document_path``` are now part of the engine-provided routes, rather than helper-provided.
+- Refactor `blacklight.js` to take advantage of the Rails asset pipeline by moving separate blocks of code into individual files.
+- Fix problem with mounting Blacklight applications at a suburi rather than a document.
+
+The full list of Github issues are at:
+https://github.com/projectblacklight/blacklight/issues?milestone=7&state=closed
+
+Also, the GitHub compare view of this release vs. our last release is
+located at:
+https://github.com/projectblacklight/blacklight/compare/v3.4.2...release-3.5
+
+
+## Upgrade Guide
+
+No known issues updating from 3.4 to 3.5.
+
+## i18n
+
+Blacklight 3.5 introduces i18n (internationalization framework) support. See the Ruby on Rails [[i18n Rails guide|http://guides.rubyonrails.org/i18n.html]] for information on how to use i18n within your application. The list of blacklight-provided (English) translations are available in the engine's [[```config/locales/blacklight.en.yml```|https://github.com/projectblacklight/blacklight/blob/master/config/locales/blacklight.en.yml]]
+
+## RecordMailer default email
+
+In config/environments/development.rb:
+```ruby
+ActionMailer::Base.default :from => 'default@development-server.com'
+```
+
+In config/environments/production.rb:
+```ruby
+ActionMailer::Base.default :from => 'default@production-server.com'
+```
+
+You can also target the RecordMailer directly:
+
+```ruby
+RecordMailer.default :from => 'no-reply@projectblacklight.org'
+```