blacklight 3.4.2 → 3.5.0

data/lib/blacklight/configuration/fields.rb

@@ -87,6 +87,8 @@ module Blacklight
         field_config.normalize!(self)
         field_config.validate!
 
+        raise "A #{config_key} with the key #{field_config.field} already exists." if self[config_key.pluralize][field_config.field].present?
+
         self[config_key.pluralize][ field_config.field ] = field_config            
       end
 

data/lib/blacklight/routes.rb

@@ -24,7 +24,7 @@ module Blacklight
     end
 
     def default_route_sets
-      [:bookmarks, :folders, :search_history, :saved_searches, :catalog, :feedback]
+      [:bookmarks, :folders, :search_history, :saved_searches, :catalog, :solr_document, :feedback]
     end
 
     module RouteSets
@@ -71,10 +71,22 @@ module Blacklight
           match 'catalog/endnote', :as => "endnote_catalog"
           match 'catalog/send_email_record', :as => "send_email_record_catalog"
           match "catalog/facet/:id", :to => 'catalog#facet', :as => 'catalog_facet'
-          resources :catalog, :only => [:index, :show, :update]
+
+
+          match "catalog", :to => 'catalog#index', :as => 'catalog_index'
+
           match 'catalog/:id/librarian_view', :to => "catalog#librarian_view", :as => "librarian_view_catalog"
         end
       end
+
+      def solr_document
+        add_routes do |options|
+          resources :solr_document,  :path => 'catalog', :controller => 'catalog', :only => [:show, :update] 
+
+          # :show and :update are for backwards-compatibility with catalog_url named routes
+          resources :catalog, :only => [:show, :update]
+        end
+      end
   
     
       # Feedback

data/lib/blacklight/search_fields.rb

@@ -67,7 +67,7 @@ module Blacklight::SearchFields
     if field_def && field_def.label
        field_def.label
     else
-       "Keyword"
+       I18n.t('blacklight.search.fields.default')
     end            
   end
 end

data/lib/blacklight/solr/document/email.rb

@@ -5,12 +5,12 @@ module Blacklight::Solr::Document::Email
   # Return a text string that will be the body of the email
   def to_email_text
     semantics = self.to_semantic_values
-    body = ""
-    body << "Title: #{semantics[:title].join(" ")}\n" unless semantics[:title].blank?
-    body << "Author: #{semantics[:author].join(" ")}\n" unless semantics[:author].blank?
-    body << "Format: #{semantics[:format].join(" ")}\n" unless semantics[:format].blank?
-    body << "Language: #{semantics[:language].join(" ")}" unless semantics[:language].blank?
-    return body unless body.blank?
+    body = []
+    body << I18n.t('blacklight.email.text.title', :value => semantics[:title].join(" ")) unless semantics[:title].blank?
+    body << I18n.t('blacklight.email.text.author', :value => semantics[:author].join(" ")) unless semantics[:author].blank?
+    body << I18n.t('blacklight.email.text.title', :value => semantics[:title].join(" ")) unless semantics[:title].blank?
+    body << I18n.t('blacklight.email.text.language', :value => semantics[:language].join(" ")) unless semantics[:language].blank?
+    return body.join("\n") unless body.empty?
   end
 
 end

data/lib/blacklight/solr/document/sms.rb

@@ -5,10 +5,10 @@ module Blacklight::Solr::Document::Sms
   # Return a text string that will be the body of the email
   def to_sms_text
     semantics = self.to_semantic_values
-    body = ""
-    body << semantics[:title].first unless semantics[:title].blank?
-    body << " by #{semantics[:author].first}" unless semantics[:author].blank?
-    return body unless body.blank?
+    body = []
+    body << I18n.t('blacklight.sms.text.title', :value => semantics[:title].first) unless semantics[:title].blank?
+    body << I18n.t('blacklight.sms.text.author', :value => semantics[:author].first) unless semantics[:author].blank?
+    return body.join unless body.empty?
   end
 
 end

data/lib/blacklight/solr_helper.rb

@@ -251,9 +251,7 @@ module Blacklight::SolrHelper
         
         solr_parameters[:fq] ||= []
         f_request_params.each_pair do |facet_field, value_list|
-          value_list ||= []
-          value_list = [value_list] unless value_list.respond_to? :each
-          value_list.each do |value|
+          Array(value_list).each do |value|
             solr_parameters[:fq] << facet_value_to_fq_string(facet_field, value)
           end              
         end      

data/lib/generators/blacklight/blacklight_generator.rb

@@ -24,6 +24,8 @@ This generator makes the following changes to your application:
 10. Creates a blacklight catalog controller in your /app/controllers directory
 11. Creates a blacklight document in your /app/models directory
 12. Adds Blacklight routes to your ./config/routes.rb
+13. Enables internationalization.
+
 Thank you for Installing Blacklight.
        """ 
 
@@ -174,5 +176,6 @@ EOF
       puts "  \e[1m\e[34mMigrations\e[0m  " + $!.message
     end
   end
+
 end  
 

data/lib/railties/blacklight_cucumber.rake

@@ -30,6 +30,12 @@ begin
         t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
         t.fork = true # You may get faster startup if you set this to false
         t.profile = 'default'
+        ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
+        if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.8/ and ruby_engine != "jruby"
+          t.rcov = true
+          t.rcov_opts = %w{--rails --exclude osx\/objc,gems\/,spec\/,features\/ --aggregate blacklight-coverage.data}
+          t.rcov_opts << %[-o "../../coverage/rcov"]
+        end
       end
 
       Cucumber::Rake::Task.new({:wip => 'db:test:prepare'}, 'Run features that are being worked on') do |t|
@@ -62,9 +68,12 @@ begin
         t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
         t.fork = true # You may get faster startup if you set this to false
         t.profile = 'default'
-        t.rcov = true
-        t.rcov_opts = %w{--rails --exclude osx\/objc,gems\/,spec\/,features\/ --aggregate blacklight-coverage.data}
-        t.rcov_opts << %[-o "blacklight-coverage"]
+        ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
+        if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.8/ and ruby_engine != "jruby"
+          t.rcov = true
+          t.rcov_opts = %w{--rails --exclude osx\/objc,gems\/,spec\/,features\/ --aggregate blacklight-coverage.data}
+          t.rcov_opts << %[-o "../../coverage/rcov"]
+        end
       end
       end	
   

data/lib/railties/blacklight_rspec.rake

@@ -54,6 +54,13 @@ begin
           
           # pattern directory name defaults to ./**/*_spec.rb, but has a more concise command line echo
           t.pattern = "#{blacklight_spec}/#{sub}" 
+
+          ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
+          if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.8/ and ruby_engine != "jruby"
+            t.rcov = true
+            t.rcov_opts = %w{--rails -I../../app -I../../lib --exclude osx\/objc,gems\/,spec\/,features\/ --aggregate blacklight-coverage.data}
+            t.rcov_opts << %[-o "../../coverage/rcov"]
+          end
         end
       end
     
@@ -62,8 +69,8 @@ begin
         t.rcov = true
         # pattern directory name defaults to ./**/*_spec.rb, but has a more concise command line echo
         t.pattern = File.join(blacklight_spec, "/**/*_spec.rb")
-          t.rspec_opts = "--colour"
-        t.rcov_opts = '-o "blacklight-coverage" --exclude /gems/,/Library/,/usr/,lib/tasks,.bundle,config,/lib/rspec/,/lib/rspec-'
+        t.rspec_opts = "--colour"
+        t.rcov_opts = '-o "../../coverage/rcov" --exclude /gems/,/Library/,/usr/,lib/tasks,.bundle,config,/lib/rspec/,/lib/rspec-'
       end
       
       # Blacklight. Solr wrapper. for now just for blacklight:spec, plan to

data/test_support/alternate_controller.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+class AlternateController < CatalogController  
+
+end 

data/test_support/bin/test.sh

@@ -63,6 +63,7 @@ if ! gem query -n bundler -v ">=1.0" --installed > /dev/null; then
 fi
 
 rails new test_app
+
 cd test_app
 rm public/index.html
 
@@ -76,7 +77,7 @@ platforms :jruby do
 end
 
 platforms :ruby do
- gem 'sqlite3-ruby', :require => 'sqlite3'
+ gem 'sqlite3'
  gem 'execjs'
  gem 'therubyracer'
 end
@@ -98,6 +99,9 @@ group :development, :test do
   gem 'cucumber-rails'
   gem 'database_cleaner'
   gem 'capybara'
+gem 'rcov', :platform => :mri_18
+gem 'simplecov', :platform => :mri_19
+gem 'simplecov-rcov', :platform => :mri_19
 end
 
 gem 'jettywrapper', '>= 1.2.0'
@@ -115,6 +119,14 @@ check_errs $? "Rake Migration failed"
 
 rails g cucumber:install &> /dev/null 
 
+cp ../../test_support/alternate_controller.rb app/controllers/
+# add routing for the alternate_controller:
+# resources :alternate do
+#   member do
+#     get :facet
+#   end
+# end
+ruby -pi.bak -e 'gsub(/devise_for :users/, "devise_for :users\n  resources :alternate do\n    member do\n      get :facet\n    end\n  end")' config/routes.rb
 
 jetty_zip=$( echo $JETTY_URL | awk '{split($0,a,"/"); print "/tmp/blacklight_jetty_"a[length(a)]}')
 if [ ! -f $jetty_zip ]

data/test_support/features/bookmarks.feature

@@ -85,4 +85,4 @@ Feature: Bookmarks
        And I have record 2007020969 in my folder
        And I follow "Selected Items"
        And I press "Add to Bookmarks"
-       Then I should see "Successfully added bookmarks."
+       Then I should see "Successfully added bookmark."

data/test_support/features/librarian_view.feature

@@ -6,7 +6,8 @@ Feature: Librarian view
   Scenario: MARC
     Given I am on the document page for id 2009373513
     When I follow "Librarian View"
-    Then I should see "LEADER 01213nam a22003614a 4500"
+    Then I should see "Librarian View"
+    And I should see "LEADER 01213nam a22003614a 4500"
     And I should see "100"
     And I should see "Lin, Xingzhi."
     And I should see "6|"

data/test_support/features/record_view.feature

@@ -22,6 +22,7 @@ Feature: Record View
     And I should see "Call number:"
     And I should see "E99.D2 H437 2008"
     And I should see link rel=alternate tags
+    And the page title should be ""Strong Medicine speaks" - Blacklight"
 
   Scenario: Blank titles do not show up
     Given I am on the document page for id 2008305903

data/test_support/features/search.feature

@@ -11,6 +11,7 @@ Feature: Search
     And I should see a "search" button
     And I should not see the "startOverLink" element
     And I should see "Welcome!"
+    And the page title should be "Blacklight Search Results"
     And I should see a stylesheet
   
   Scenario: Search Page's type of search ("fielded search") choices

data/test_support/features/step_definitions/general_steps.rb

@@ -9,6 +9,10 @@ Then /^I should see a stylesheet/ do
   page.should have_selector("link[rel=stylesheet]")
 end
 
+Then /^the page title should be "([^"]*)"$/i do |title|
+  page.should have_selector("title", :content => title)
+end
+
 Then /I should see "(.*)" (at least|at most|exactly) (.*) times?$/i do |target, comparator, expected_num|
   actual_num = page.split(target).length - 1
   case comparator

data/test_support/features/support/env.rb

@@ -17,7 +17,18 @@
 # * http://benmabey.com/2008/05/19/imperative-vs-declarative-scenarios-in-user-stories.html
 # * http://dannorth.net/2011/01/31/whose-domain-is-it-anyway/
 # * http://elabs.se/blog/15-you-re-cuking-it-wrong 
-#
+
+
+ruby_engine = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
+if ENV['COVERAGE'] and RUBY_VERSION =~ /^1.9/ and ruby_engine != "jruby"
+  require 'simplecov'
+  require 'simplecov-rcov'
+
+  SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+  SimpleCov.start do
+    root File.expand_path(File.dirname(__FILE__) + "../../../..")
+  end
+end
 
 require 'cucumber/rails'
 

data/test_support/features/support/paths.rb

@@ -14,7 +14,8 @@ module NavigationHelpers
 
       
     when /the catalog page/
-      catalog_index_path
+      #catalog_index_path
+      root_path
       
     when /the folder page/
       folder_index_path

data/test_support/spec/helpers/blacklight_helper_spec.rb

@@ -93,7 +93,7 @@ describe BlacklightHelper do
 
   describe "link_back_to_catalog" do
     before(:all) do
-      @query_params = {:q => "query", :f => "facets", :per_page => "10", :page => "2"}
+      @query_params = {:q => "query", :f => "facets", :per_page => "10", :page => "2", :controller=>'catalog'}
     end
     it "should build a link tag to catalog using session[:search] for query params" do
       session[:search] = @query_params
@@ -211,6 +211,9 @@ describe BlacklightHelper do
    end
 
    describe "document_partial_name" do
+     it "should default to 'default' when a format blank" do
+       document_partial_name({}).should == "default"
+     end
      it "should handle normal formats correctly" do
        document_partial_name({"format" => "myformat"}).should == "myformat"
      end
@@ -294,6 +297,9 @@ describe BlacklightHelper do
          def export_as_weird_dup ; "weird_dup" ; end
       end
       MockDocumentAppHelper.use_extension(MockExtension)
+      def mock_document_app_helper_url *args
+        solr_document_url(*args)
+      end
     before(:each) do
       @doc_id = "MOCK_ID1"
       @document = MockDocumentAppHelper.new(:id => @doc_id)
@@ -310,7 +316,7 @@ describe BlacklightHelper do
           tag = matches[0]
           tag.attributes["rel"].value.should == "alternate"
           tag.attributes["title"].value.should == format.to_s
-          tag.attributes["href"].value.should === catalog_url(@doc_id, format)
+          tag.attributes["href"].value.should === mock_document_app_helper_url(@document, :format =>format)
         end        
       end
     end

data/test_support/spec/helpers/search_history_constraints_helper_spec.rb

@@ -4,24 +4,12 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe SearchHistoryConstraintsHelper do
 
   before(:all) do
-    @config = Blacklight::Configuration.from_legacy_configuration({ 
-      :default_search_field => {
-       :key => 'default_search_field',
-       :display_label => "Default"
-     },
-     :facet => {
-       :field_names => [
-         'some_facet',
-         'other_facet'
-        ],
-        :labels => { 
-          'some_facet' => 'Some',
-          'other_facet' => 'Other'
-        },
-        :limits => {
-        }
-      }
-    })
+    @config = Blacklight::Configuration.new do |config|
+      config.add_search_field 'default_search_field', :label => 'Default'
+
+      config.add_facet_field 'some_facet', :label => 'Some'
+      config.add_facet_field 'other_facet', :label => 'Other'
+    end
   end
 
 

data/test_support/spec/lib/search_fields_spec.rb

@@ -8,15 +8,15 @@ describe Blacklight::SearchFields do
   end
 
   before(:all) do
-    @config = Blacklight::Configuration.from_legacy_configuration({:search_fields => [ {:label => 'All Fields', :key => "all_fields"},
-                           {:key => 'title', :qt => 'title_search'},
-                           {:key => 'author', :qt => 'author_search'},
-                           {:key => 'subject', :qt=> 'subject_search'},
-                           ['Legacy Config', 'legacy_qt'],
-                           {:key => "no_display", :qt=>"something", :include_in_simple_select => false}
-                          ],
-                           :default_solr_params => { :qt => "search" }
-    })
+    @config = Blacklight::Configuration.new do |config|
+      config.default_solr_params = { :qt => 'search' }
+      
+      config.add_search_field 'all_fields', :label => 'All Fields'
+      config.add_search_field 'title', :qt => 'title_search'
+      config.add_search_field 'author', :qt => 'author_search'
+      config.add_search_field 'subject', :qt => 'subject_search'
+      config.add_search_field 'no_display', :qt => 'something', :include_in_simple_select => false
+    end
   end
 
   before(:each) do  
@@ -24,14 +24,6 @@ describe Blacklight::SearchFields do
     @search_field_obj.stub!(:blacklight_config).and_return(@config)
   end
 
-  it 'should convert legacy Array config to Hash properly' do
-    hash = @search_field_obj.search_field_def_for_key('legacy_qt')
-
-    hash.should be_kind_of(Blacklight::Configuration::SearchField)
-    hash.key.should == hash.qt
-    hash.label.should == 'Legacy Config'
-  end
-  
   it "should return search field list with calculated :label when needed" do
      @search_field_obj.search_field_list.each do |hash|        
         hash.label.should_not be_blank
@@ -81,10 +73,10 @@ describe Blacklight::SearchFields do
       @bad_config = MockConfig.new
     end
     it "should raise exception on #search_field_list" do
-      lambda { @bad_config.stub(:blacklight_config).and_return(Blacklight::Configuration.from_legacy_configuration({:search_fields => [ 
-        {:label => 'All Fields', :qt => "all_fields"},
-        {:key => 'title', :qt => 'title_search'}
-      ]}))   }.should raise_error
+      lambda { @bad_config.stub(:blacklight_config).and_return(Blacklight::Configuration.new { |config|
+           config.add_search_field :label => 'All Fields', :qt => 'all_fields'
+           config.add_search_field 'title', :qt => 'title_search'
+      })   }.should raise_error
     end
   end
 
@@ -93,10 +85,11 @@ describe Blacklight::SearchFields do
       @bad_config = MockConfig.new
     end
     it "should raise on #search_field_list" do
-      lambda { @bad_config.stub(:blacklight_config).and_return(Blacklight::Configuration.from_legacy_configuration({:search_fields => [ 
-        {:label => 'All Fields', :qt => "my_key"},
-        {:key => 'title', :qt => 'my_key'}
-      ]})) }.should raise_error
+      lambda { @bad_config.stub(:blacklight_config).and_return(Blacklight::Configuration.new { |config|
+        config.add_search_field 'my_key', :label => 'All Fields'
+        config.add_search_field 'my_key', :label => 'title'
+
+      }) }.should raise_error
     end
   end
   

data/test_support/spec/models/record_mailer_spec.rb

@@ -4,6 +4,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe RecordMailer do
   before(:each) do
+    RecordMailer.stub(:default) { { :from => 'no-reply@projectblacklight.org' } }
     SolrDocument.use_extension( Blacklight::Solr::Document::Email )
     SolrDocument.use_extension( Blacklight::Solr::Document::Sms )
     document = SolrDocument.new({:id=>"123456", :format=>["book"], :title_display => "The horn", :language_facet => "English", :author_display => "Janetzky, Kurt"})
@@ -12,7 +13,7 @@ describe RecordMailer do
   describe "email" do
     before(:each) do
       details = {:to => 'test@test.com', :message => "This is my message"}
-      @email = RecordMailer.email_record(@documents,details,'projectblacklight.org',{:host =>'projectblacklight.org', :protocol => 'https'}) 
+      @email = RecordMailer.email_record(@documents,details,{:host =>'projectblacklight.org', :protocol => 'https'}) 
     end
     it "should receive the TO paramater and send the email to that address" do
       @email.to.should == ['test@test.com']
@@ -33,7 +34,7 @@ describe RecordMailer do
     end
     it "should use https URLs when protocol is set" do
       details = {:to => 'test@test.com', :message => "This is my message"}
-      @https_email = RecordMailer.email_record(@documents,details,'projectblacklight.org',{:host =>'projectblacklight.org', :protocol => 'https'})
+      @https_email = RecordMailer.email_record(@documents,details,{:host =>'projectblacklight.org', :protocol => 'https'})
       @https_email.body.should =~ %r|https://projectblacklight.org/|
     end
   end
@@ -41,7 +42,7 @@ describe RecordMailer do
   describe "SMS" do
     before(:each) do
       details = {:to => '5555555555', :carrier => 'att'}
-      @sms = RecordMailer.sms_record(@documents,details,'projectblacklight.org',{:host =>'projectblacklight.org:3000'})
+      @sms = RecordMailer.sms_record(@documents,details,{:host =>'projectblacklight.org:3000'})
     end
     it "should create the correct TO address for the SMS email" do
       @sms.to.should == ['5555555555@txt.att.net']
@@ -59,7 +60,7 @@ describe RecordMailer do
     end
     it "should use https URL when protocol is set" do
       details = {:to => '5555555555', :carrier => 'att'}
-      @https_sms = RecordMailer.sms_record(@documents,details,'projectblacklight.org',{:host =>'projectblacklight.org', :protocol => 'https'})
+      @https_sms = RecordMailer.sms_record(@documents,details,{:host =>'projectblacklight.org', :protocol => 'https'})
       @https_sms.body.should =~ %r|https://projectblacklight.org/|
     end
   end