blacklight 4.0.1 → 4.1.0

data/lib/blacklight/configurable.rb

@@ -6,10 +6,9 @@ module Blacklight::Configurable
     helper_method :blacklight_config if respond_to? :helper_method
   end
   
-  #instance methods for blacklight_config, default to class
-  # version unless set specifically on instance
+  #instance methods for blacklight_config, so get a deep copy of the class-level config
   def blacklight_config
-    @blacklight_config || self.class.blacklight_config
+    @blacklight_config ||= self.class.blacklight_config.deep_copy
   end
   attr_writer :blacklight_config
 

data/lib/blacklight/configuration/fields.rb

@@ -1,6 +1,5 @@
 module Blacklight
   class Configuration
-
     # This mixin provides Blacklight::Configuration with generic
     # solr fields configuration
     module Fields
@@ -9,14 +8,16 @@ module Blacklight
       module ClassMethods
 
         # Add a configuration block for a collection of solr fields
-        def define_field_access(key)
+        def define_field_access(key, options = {})
           key = key.to_s if respond_to? :to_s
 
           self.default_values[key.pluralize.to_sym] = ActiveSupport::OrderedHash.new
 
+          base_class_name = options.fetch(:class, SolrField)
+
           unless self.const_defined? key.camelcase
             class_eval <<-END_EVAL, __FILE__, __LINE__ + 1
-              class #{key.camelcase} < SolrField; end
+              class #{key.camelcase} < #{base_class_name}; end
             END_EVAL
           end
     
@@ -70,7 +71,7 @@ module Blacklight
           when String
             field_config_from_key_and_hash(config_key, *args)
           when Symbol
-            args.first = args.first.to_s
+            args[0] = args[0].to_s
             field_config_from_key_and_hash(config_key, *args)
           when Array
             field_config_from_array(config_key, *args)

data/lib/blacklight/mash.rb

@@ -1,151 +1,19 @@
 # This class has dubious semantics and we only have it so that people can write
 # params[:key] instead of params['key'].
-class Mash < Hash
+class Mash < HashWithIndifferentAccess
+  def initialize *args, &block
+    ActiveSupport::Deprecation.warn("Mash is deprecated, and should be replaced with HashWithIndifferentAccess")
 
-  # @param constructor<Object>
-  #   The default value for the mash. Defaults to an empty hash.
-  #
-  # @details [Alternatives]
-  #   If constructor is a Hash, a new mash will be created based on the keys of
-  #   the hash and no default value will be set.
-  def initialize(constructor = {})
-    if constructor.is_a?(Hash) 
-      super() 
-      update(constructor) 
-    else 
-      super(constructor) 
-    end 
-  end
-
-  # @param key<Object> The default value for the mash. Defaults to nil.
-  #
-  # @details [Alternatives]
-  #   If key is a Symbol and it is a key in the mash, then the default value will
-  #   be set to the value matching the key.
-  def default(key = nil) 
-    if key.is_a?(Symbol) && include?(key = key.to_s) 
-      self[key] 
-    else 
-      super 
-    end 
-  end 
- 
-  alias_method :regular_writer, :[]= unless method_defined?(:regular_writer) 
-  alias_method :regular_update, :update unless method_defined?(:regular_update)
-
-  # @param key<Object> The key to set.
-  # @param value<Object>
-  #   The value to set the key to.
-  #
-  # @see Mash#convert_key
-  # @see Mash#convert_value
-  def []=(key, value) 
-    regular_writer(convert_key(key), convert_value(value)) 
-  end
-
-  # @param other_hash<Hash>
-  #   A hash to update values in the mash with. The keys and the values will be
-  #   converted to Mash format.
-  #
-  # @return <Mash> The updated mash.
-  def update(other_hash) 
-    other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) } 
-    self 
-  end 
- 
-  alias_method :merge!, :update
-
-  # @param key<Object> The key to check for. This will be run through convert_key.
-  #
-  # @return <TrueClass, FalseClass> True if the key exists in the mash.
-  def key?(key) 
-    super(convert_key(key)) 
-  end 
-
-  # def include? def has_key? def member?
-  alias_method :include?, :key?
-  alias_method :has_key?, :key?
-  alias_method :member?, :key?
-
-  # @param key<Object> The key to fetch. This will be run through convert_key.
-  # @param *extras<Array> Default value.
-  #
-  # @return <Object> The value at key or the default value.
-  def fetch(key, *extras) 
-    super(convert_key(key), *extras) 
-  end
-
-  # @param *indices<Array>
-  #   The keys to retrieve values for. These will be run through +convert_key+.
-  #
-  # @return <Array> The values at each of the provided keys
-  def values_at(*indices) 
-    indices.collect {|key| self[convert_key(key)]} 
-  end
-
-  # @return <Mash> A duplicate of this mash.
-  def dup 
-    Mash.new(self) 
-  end
-
-  # @param hash<Hash> The hash to merge with the mash.
-  #
-  # @return <Mash> A new mash with the hash values merged in.
-  def merge(hash) 
-    self.dup.update(hash) 
-  end
-
-  # @param key<Object>
-  #   The key to delete from the mash.\
-  def delete(key) 
-    super(convert_key(key)) 
-  end
-
-  # Used to provide the same interface as Hash.
-  #
-  # @return <Mash> This mash unchanged.
-  def stringify_keys!; self end
- 
-  # @return <Hash> The mash as a Hash with string keys.
-  def to_hash 
-    Hash.new(default).merge(self) 
-  end 
- 
-  protected
-  # @param key<Object> The key to convert.
-  #
-  # @param <Object>
-  #   The converted key. If the key was a symbol, it will be converted to a
-  #   string.
-  #
-  # @api private
-  def convert_key(key) 
-    key.kind_of?(Symbol) ? key.to_s : key 
-  end
-
-  # @param value<Object> The value to convert.
-  #
-  # @return <Object>
-  #   The converted value. A Hash or an Array of hashes, will be converted to
-  #   their Mash equivalents.
-  #
-  # @api private
-  def convert_value(value) 
-    case value 
-    when Hash 
-      value.to_mash 
-    when Array 
-      value.collect { |e| convert_value(e) } 
-    else 
-      value 
-    end 
+    super
   end
 end
 
 unless Hash.respond_to?(:to_mash)
   class Hash
     def to_mash
-      Mash.new(self)
+      ActiveSupport::Deprecation.warn("Hash#to_mash is deprecated, and should be replaced with #with_indifferent_access")
+
+      HashWithIndifferentAccess.new(self)
     end
   end
 end

data/lib/blacklight/routes.rb

@@ -30,43 +30,44 @@ module Blacklight
     module RouteSets
       def bookmarks
         add_routes do |options|
-          match "bookmarks/clear", :to => "bookmarks#clear", :as => "clear_bookmarks"
+          delete "bookmarks/clear", :to => "bookmarks#clear", :as => "clear_bookmarks"
           resources :bookmarks
         end
       end
   
       def search_history
         add_routes do |options|
-          match "search_history",             :to => "search_history#index",   :as => "search_history"
-          match "search_history/clear",       :to => "search_history#clear",   :as => "clear_search_history"          
+          get "search_history",             :to => "search_history#index",   :as => "search_history"
+          delete "search_history/clear",       :to => "search_history#clear",   :as => "clear_search_history"          
         end
       end
   
   
       def saved_searches
         add_routes do |options|
-          match "saved_searches/clear",       :to => "saved_searches#clear",   :as => "clear_saved_searches"
-          match "saved_searches",       :to => "saved_searches#index",   :as => "saved_searches"
-          match "saved_searches/save/:id",    :to => "saved_searches#save",    :as => "save_search"
-          match "saved_searches/forget/:id",  :to => "saved_searches#forget",  :as => "forget_search"
+          delete "saved_searches/clear",       :to => "saved_searches#clear",   :as => "clear_saved_searches"
+          get "saved_searches",       :to => "saved_searches#index",   :as => "saved_searches"
+          put "saved_searches/save/:id",    :to => "saved_searches#save",    :as => "save_search"
+          delete "saved_searches/forget/:id",  :to => "saved_searches#forget",  :as => "forget_search"
+          post "saved_searches/forget/:id",  :to => "saved_searches#forget",  :as => "forget_search"
         end
       end
     
       def catalog
         add_routes do |options|
           # Catalog stuff.
-          match 'catalog/opensearch', :as => "opensearch_catalog"
-          match 'catalog/citation', :as => "citation_catalog"
-          match 'catalog/email', :as => "email_catalog"
-          match 'catalog/sms', :as => "sms_catalog"
-          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'
+          get 'catalog/opensearch', :as => "opensearch_catalog"
+          get 'catalog/citation', :as => "citation_catalog"
+          get 'catalog/email', :as => "email_catalog"
+          get 'catalog/sms', :as => "sms_catalog"
+          get 'catalog/endnote', :as => "endnote_catalog"
+          get 'catalog/send_email_record', :as => "send_email_record_catalog"
+          get "catalog/facet/:id", :to => 'catalog#facet', :as => 'catalog_facet'
 
 
-          match "catalog", :to => 'catalog#index', :as => 'catalog_index'
+          get "catalog", :to => 'catalog#index', :as => 'catalog_index'
 
-          match 'catalog/:id/librarian_view', :to => "catalog#librarian_view", :as => "librarian_view_catalog"
+          get 'catalog/:id/librarian_view', :to => "catalog#librarian_view", :as => "librarian_view_catalog"
         end
       end
 
@@ -83,8 +84,8 @@ module Blacklight
       # Feedback
       def feedback
         add_routes do |options|
-          match "feedback", :to => "feedback#show"    
-          match "feedback/complete", :to => "feedback#complete"
+          get "feedback", :to => "feedback#show"    
+          get "feedback/complete", :to => "feedback#complete"
         end
       end
     end

data/lib/blacklight/solr_helper.rb

@@ -84,10 +84,10 @@ module Blacklight::SolrHelper
   
   def find(*args)
     path = blacklight_config.solr_path
-    response = Blacklight.solr.get(path, :params=> args[1])
+    response = blacklight_solr.get(path, :params=> args[1])
     Blacklight::SolrResponse.new(force_to_utf8(response), args[1])
   rescue Errno::ECONNREFUSED => e
-    raise Blacklight::Exceptions::ECONNREFUSED.new("Unable to connect to Solr instance using #{Blacklight.solr.inspect}")
+    raise Blacklight::Exceptions::ECONNREFUSED.new("Unable to connect to Solr instance using #{blacklight_solr.inspect}")
   end
     
   
@@ -154,6 +154,7 @@ module Blacklight::SolrHelper
       end
 
       # Now any over-rides from current URL?
+      solr_params[:rows] = user_params[:rows].to_i  unless user_params[:rows].blank?
       solr_params[:rows] = user_params[:per_page].to_i  unless user_params[:per_page].blank?
 
       # Do we need to translate :page to Solr :start?
@@ -166,8 +167,8 @@ module Blacklight::SolrHelper
         if solr_params[:rows].blank?
           raise Exception.new("To use pagination when no :per_page is supplied in the URL, :rows must be configured in blacklight_config default_solr_params")
         end
-
-        solr_params[:page] = user_params[:page].to_i
+        solr_params[:start] = solr_params[:rows].to_i * (user_params[:page].to_i - 1)
+        solr_params[:start] = 0 if solr_params[:start].to_i < 0
       end
 
       solr_params[:rows] ||= blacklight_config.per_page.first unless blacklight_config.per_page.blank?
@@ -381,14 +382,16 @@ module Blacklight::SolrHelper
     # In later versions of Rails, the #benchmark method can do timing
     # better for us. 
     bench_start = Time.now
-    params = self.solr_search_params(user_params).merge(extra_controller_params)
-    params[:qt] ||= blacklight_config.qt
+    solr_params = self.solr_search_params(user_params).merge(extra_controller_params)
+    solr_params[:qt] ||= blacklight_config.qt
     path = blacklight_config.solr_path
-    raise "don't set start, use page and rows instead" if params['start'] || params[:start]
-    rows = params.delete(:rows) #only transmit rows once
-    res = Blacklight.solr.paginate(params[:page] || 1, rows, path, :params=>params)
-    solr_response = Blacklight::SolrResponse.new(force_to_utf8(res), params)
-    Rails.logger.debug("Solr query: #{params.inspect}") 
+
+    # delete these parameters, otherwise rsolr will pass them through.
+    res = blacklight_solr.send_and_receive(path, :params=>solr_params)
+    
+    solr_response = Blacklight::SolrResponse.new(force_to_utf8(res), solr_params)
+
+    Rails.logger.debug("Solr query: #{solr_params.inspect}")
     Rails.logger.debug("Solr response: #{solr_response.inspect}") if defined?(::BLACKLIGHT_VERBOSE_LOGGING) and ::BLACKLIGHT_VERBOSE_LOGGING
     Rails.logger.debug("Solr fetch: #{self.class}#query_solr (#{'%.1f' % ((Time.now.to_f - bench_start.to_f)*1000)}ms)")
     

data/lib/blacklight/solr_response.rb

@@ -1,4 +1,4 @@
-class Blacklight::SolrResponse < Mash
+class Blacklight::SolrResponse < HashWithIndifferentAccess
 
   autoload :Spelling, 'blacklight/solr_response/spelling'
   autoload :Facets, 'blacklight/solr_response/facets'

data/lib/generators/blacklight/blacklight_generator.rb

@@ -71,8 +71,16 @@ EOF
   # Install Devise? 
   def generate_devise_assets
     if options[:devise]
-      gem "devise"
+      if Rails::VERSION::MAJOR == 4
+        gem "devise", github:'plataformatec/devise', branch: 'rails4'
+      else
+        gem "devise"
+      end
+      
       gem "devise-guests", "~> 0.3"
+      if Rails::VERSION::MAJOR == 4
+        gem 'protected_attributes' # Required for devise
+      end
 
       Bundler.with_clean_env do
        run "bundle install"

data/lib/generators/blacklight/test_support_generator.rb

@@ -31,5 +31,20 @@ Requires system('unzip... ') to work, probably won't work on Windows.
 
 
     end
+
+    def configure_action_mailer
+
+      if Rails::VERSION::MAJOR == 4
+        insert_into_file "config/environments/test.rb", :after => "config.action_mailer.delivery_method = :test\n" do <<-EOF
+           config.action_mailer.default_options = {from: 'no-reply@example.org'}
+        EOF
+        end
+      else
+        insert_into_file "config/environments/test.rb", :after => "config.action_mailer.delivery_method = :test\n" do <<-EOF
+          ActionMailer::Base.default(from: 'no-reply@example.org')
+        EOF
+        end
+      end
+    end
   end
 end

data/test_support/bin/setup-test-app.sh

@@ -89,23 +89,19 @@ end
 gem 'blacklight', :path => '../../'
 gem 'jquery-rails'
 
-group :assets do
-  gem 'compass-rails', '~> 1.0.0'
-  gem 'compass-susy-plugin', '~> 0.9.0'
-end
-
-
 # For testing
 group :development, :test do 
-  gem 'rspec'
-  gem 'rspec-rails'
+  gem 'rspec-rails', '~> 2.12.0'
+end
+
+group :test do
+  gem 'cucumber-rails', :require => false
   gem 'generator_spec'
-  gem 'cucumber-rails'
   gem 'database_cleaner'
   gem 'capybara'
-gem 'rcov', :platform => :mri_18
-gem 'simplecov', :platform => :mri_19
-gem 'simplecov-rcov', :platform => :mri_19
+  gem 'rcov', :platform => :mri_18
+  gem 'simplecov', :platform => :mri_19
+  gem 'simplecov-rcov', :platform => :mri_19
 end
 
 gem 'jettywrapper', '>= 1.2.0'

data/test_support/bin/test.sh

@@ -2,8 +2,7 @@
 # test.sh
 # Create a default rails appliaction, install blacklight, and run all the tests.
 
-#If null or empty, use default value
-RAILS_VERSION=${RAILS_VERSION:-"~> 3.2"}
+#If null or empty, use default valueRAILS
 JETTY_URL=${JETTY_URL:-"https://github.com/projectblacklight/blacklight-jetty/zipball/v4.0.0"}
 
 before="$(date +%s)"
@@ -38,7 +37,6 @@ rm -rf tmp/test_app
 mkdir -p tmp/test_app
 cd tmp
 
-
 if [[  $# -gt 0 ]]
 then
 # Make certain rvm will work correctly.
@@ -58,18 +56,20 @@ rvm use "$@" --create
 check_errs $? "rvm failed.  please run 'rvm install $@', and then re-run these tests."
 fi
 
-if ! gem query -n rails -v "$RAILS_VERSION" --installed > /dev/null; then
-  gem install --no-rdoc --no-ri 'rails' -v "$RAILS_VERSION"
-fi
+rails new test_app
 
-if ! gem query -n bundler -v ">=1.0" --installed > /dev/null; then
-  gem install --no-rdoc --no-ri 'bundler'
+cd test_app
+
+if [ -e public/index.html ]; then
+  rm public/index.html
 fi
 
-rails new test_app
 
-cd test_app
-rm public/index.html
+if [ "${TRAVIS}" = "true" ]; then
+  echo "adding utf-8 header for the css under travis"
+  echo '@charset "UTF-8";'|cat - app/assets/stylesheets/application.css > app/assets/stylesheets/application.css.utf8 && mv app/assets/stylesheets/application.css.utf8 app/assets/stylesheets/application.css
+fi
+
 
 echo "
 platforms :jruby do
@@ -89,27 +89,23 @@ end
 gem 'blacklight', :path => '../../'
 gem 'jquery-rails'
 
-group :assets do
-  gem 'compass-rails', '~> 1.0.0'
-  gem 'compass-susy-plugin', '~> 0.9.0'
-end
-
-
 # For testing
 group :development, :test do
-  gem 'rspec'
-  gem 'rspec-rails'
+  gem 'rspec-rails', '~> 2.12.0'
+end
+
+group :test do
   gem 'generator_spec'
-  gem 'cucumber-rails'
-  gem 'database_cleaner'
+  gem 'cucumber-rails', :require => false
+  gem 'database_cleaner', '>= 1.0.0.RC1'
   if defined? :JRUBY_VERSION
     gem 'capybara', '~> 1.0'
   else
     gem 'capybara'
   end
-gem 'rcov', :platform => :mri_18
-gem 'simplecov', :platform => :mri_19
-gem 'simplecov-rcov', :platform => :mri_19
+  gem 'rcov', :platform => :mri_18
+  gem 'simplecov', :platform => :mri_19
+  gem 'simplecov-rcov', :platform => :mri_19
 end
 
 gem 'jettywrapper', '>= 1.2.0'