blacklight 4.6.3 → 4.7.0.pre1

data/lib/blacklight/utils.rb

@@ -1,7 +1,7 @@
 require 'ostruct'
 module Blacklight
   class OpenStructWithHashAccess < OpenStruct
-    delegate :keys, :merge, :to => :to_h
+    delegate :keys, :reject!, :select!, :include, :fetch, :to => :to_h
 
     def []=(key, value)
       send "#{key}=", value
@@ -14,5 +14,13 @@ module Blacklight
     def to_h
       @table
     end
+
+    def merge other_hash
+      self.class.new to_h.merge((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
+    end
+
+    def merge! other_hash
+      @table.merge!((other_hash if other_hash.is_a? Hash) || other_hash.to_h)
+    end 
   end
 end

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

@@ -1,6 +1,5 @@
 # -*- encoding : utf-8 -*-
-require 'blacklight/catalog'
-
+#
 class CatalogController < ApplicationController  
 
   include Blacklight::Catalog
@@ -175,6 +174,4 @@ class CatalogController < ApplicationController
     config.spell_max = 5
   end
 
-
-
 end 

data/spec/helpers/blacklight_helper_spec.rb

@@ -180,7 +180,24 @@ describe BlacklightHelper do
     end
   end
 
+  describe "sanitize_search_params" do
+    it "should strip nil values" do
+      result = sanitize_search_params(:a => nil, :b => 1)
+      expect(result).to_not have_key(:a)
+      expect(result[:b]).to eq 1
+    end
+
+    it "should remove blacklisted keys" do
+      result = sanitize_search_params(:action => true, :controller => true, :id => true, :commit => true, :utf8 => true)
+      expect(result).to be_empty
+    end
+  end
+
   describe "params_for_search" do
+    around(:each) do |example|
+      Deprecation.silence(Blacklight::BlacklightHelperBehavior) { example.run }
+    end
+
     def params
       { 'default' => 'params'}
     end
@@ -192,47 +209,61 @@ describe BlacklightHelper do
     end
 
     it "should let you pass in params to use" do
+      source_params = { :q => 'query'}
+      result = params_for_search(source_params, {})
+      source_params.should == result
+      source_params.object_id.should_not == result.object_id
+    end
+
+    it "should let you pass in params to use (the deprecated way)" do
       source_params = { :q => 'query'}
       result = params_for_search(:params => source_params )
       source_params.should == result
       source_params.object_id.should_not == result.object_id
     end
+    
+
+    it "should let you pass in params to merge into the controller's params" do
+      source_params = { :q => 'query'}
+      result = params_for_search( source_params )
+      expect(result).to include(:q => 'query', 'default' => 'params')
+    end
 
     it "should not return blacklisted elements" do
       source_params = { :action => 'action', :controller => 'controller', :id => "id", :commit => 'commit'}
-      result = params_for_search(:params => source_params )
+      result = params_for_search(source_params, {} )
       result.keys.should_not include(:action, :controller, :commit, :id)
 
     end
 
     it "should adjust the current page if the per_page changes" do
       source_params = { :per_page => 20, :page => 5}
-      result = params_for_search(:params => source_params, :per_page => 100)
+      result = params_for_search(source_params, :per_page => 100)
       result[:page].should == 1
     end
 
     it "should not adjust the current page if the per_page is the same as it always was" do
       source_params = { :per_page => 20, :page => 5}
-      result = params_for_search(:params => source_params, :per_page => 20)
+      result = params_for_search(source_params, :per_page => 20)
       result[:page].should == 5
     end
 
     it "should adjust the current page if the sort changes" do
       source_params = { :sort => 'field_a', :page => 5}
-      result = params_for_search(:params => source_params, :sort => 'field_b')
+      result = params_for_search(source_params, :sort => 'field_b')
       result[:page].should == 1
     end
 
     it "should not adjust the current page if the sort is the same as it always was" do
       source_params = { :sort => 'field_a', :page => 5}
-      result = params_for_search(:params => source_params, :sort => 'field_a')
+      result = params_for_search(source_params, :sort => 'field_a')
       result[:page].should == 5
     end
 
     describe "omit keys parameter" do
       it "should omit keys by key name" do
         source_params = { :a => 1, :b => 2, :c => 3}
-        result = params_for_search(:params => source_params, :omit_keys => [:a, :b] )
+        result = params_for_search(source_params, :omit_keys => [:a, :b] )
 
         result.keys.should_not include(:a, :b)
         result[:c].should == 3
@@ -240,19 +271,33 @@ describe BlacklightHelper do
 
       it "should remove keys if a key/value pair was passed and no values are left for that key" do
         source_params = { :f => ['a']}
-        result = params_for_search(:params => source_params, :omit_keys => [{:f => 'a' }])
+        result = params_for_search(source_params, :omit_keys => [{:f => 'a' }])
         result.keys.should_not include(:f)
       end
 
       it "should only remove keys when a key/value pair is based that are in that pair" do
 
         source_params = { :f => ['a', 'b']}
-        result = params_for_search(:params => source_params, :omit_keys => [{:f => 'a' }])
+        result = params_for_search(source_params, :omit_keys => [{:f => 'a' }])
         result[:f].should_not include('a')
         result[:f].should include('b')
       end
     end
 
+     describe "params_for_search with a block" do
+      it "should evalute the block and allow it to add or remove keys" do
+        result = params_for_search({:a => 1, :b => 2}, :c => 3) do |params|
+          params.except! :a, :b 
+          params[:d] = 'd'
+        end
+
+        result.keys.should_not include(:a, :b)
+        expect(result[:c]).to eq 3
+        expect(result[:d]).to eq 'd'
+      end
+
+    end
+
   end
 
   describe "search_as_hidden_fields" do
@@ -261,7 +306,9 @@ describe BlacklightHelper do
     end
     describe "for default arguments" do
       it "should default to omitting :page" do
-        search_as_hidden_fields.should_not have_selector("input[name='page']")
+        Deprecation.silence(Blacklight::BlacklightHelperBehavior) do
+          search_as_hidden_fields.should_not have_selector("input[name='page']")
+        end
       end
     end
  end
@@ -744,4 +791,32 @@ describe BlacklightHelper do
       expect(helper.render_field_value(['c', 'd'], double(:separator => '; '))).to eq "c; d"
     end
   end
+
+  describe "link_to_previous_search" do
+    it "should link to the given search parameters" do
+      params = {}
+      helper.should_receive(:render_search_to_s).with(params).and_return "link text"
+      expect(helper.link_to_previous_search({})).to eq helper.link_to("link text", catalog_index_path)
+    end
+  end
+
+  describe "should_show_spellcheck_suggestions?" do
+    before :each do
+      helper.stub spell_check_max: 5
+    end
+    it "should not show suggestions if there are enough results" do
+      response = double(total: 10)
+      expect(helper.should_show_spellcheck_suggestions? response).to be_false
+    end
+
+    it "should only show suggestions if there are very few results" do
+      response = double(total: 4, spelling: double(words: [1]))
+      expect(helper.should_show_spellcheck_suggestions? response).to be_true
+    end
+
+    it "should show suggestions only if there are spelling suggestions available" do
+      response = double(total: 4, spelling: double(words: []))
+      expect(helper.should_show_spellcheck_suggestions? response).to be_false
+    end
+  end
 end

data/spec/helpers/hash_as_hidden_fields_spec.rb

@@ -9,7 +9,7 @@ describe HashAsHiddenFieldsHelper do
 
   it "should convert a hash with nested complex data to Rails-style hidden form fields" do
 
-    generated = hash_as_hidden_fields(@hash)
+    generated = render_hash_as_hidden_fields(@hash)
 
     generated.should have_selector("input[type='hidden'][name='q'][value='query']")
     generated.should have_selector("input[type='hidden'][name='per_page'][value='10']")

data/spec/lib/blacklight_spec.rb

@@ -2,6 +2,12 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Blacklight do
+
+  around :each do |example|
+    Deprecation.silence(Blacklight) do
+      example.run
+    end
+  end
   
   context "locate_path" do
     

data/spec/lib/blacklight_user_spec.rb

@@ -4,6 +4,10 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe "Blacklight::User" do
 
   subject { User.create! :email => 'xyz@example.com', :password => 'xyz12345' }
+  
+  around(:each) do |example|
+    Deprecation.silence(Blacklight::User) { example.run }
+  end
 
   def mock_bookmark document_id
     Bookmark.new :document_id => document_id

data/spec/lib/solr_helper_spec.rb

@@ -32,7 +32,9 @@ describe 'Blacklight::SolrHelper' do
   end
 
   def blacklight_solr
-    Blacklight.solr
+    Deprecation.silence(Blacklight) {
+      Blacklight.solr
+    }
   end
 
   include Blacklight::SolrHelper
@@ -566,7 +568,7 @@ describe 'Blacklight::SolrHelper' do
 
       it "should use the configured request handler " do
         blacklight_config.stub(:default_solr_params).and_return({:qt => 'custom_request_handler'})
-        Blacklight.solr.should_receive(:send_and_receive) do |path, params|
+        blacklight_solr.should_receive(:send_and_receive) do |path, params|
           path.should == 'select'
           params[:params][:'facet.field'].should == ["format", "{!ex=pub_date_single}pub_date", "subject_topic_facet", "language_facet", "lc_1letter_facet", "subject_geo_facet", "subject_era_facet"]
           params[:params][:"facet.query"].should == ["pub_date:[#{5.years.ago.year} TO *]", "pub_date:[#{10.years.ago.year} TO *]", "pub_date:[#{25.years.ago.year} TO *]"]
@@ -860,7 +862,7 @@ describe 'Blacklight::SolrHelper' do
 
     it "should use a provided document request handler " do
       blacklight_config.stub(:document_solr_request_handler => 'document')
-      Blacklight.solr.should_receive(:get).with('select', kind_of(Hash)).and_return({'response'=>{'docs'=>[]}})
+      blacklight_solr.should_receive(:get).with('select', kind_of(Hash)).and_return({'response'=>{'docs'=>[]}})
       lambda { get_solr_response_for_doc_id(@doc_id)}.should raise_error Blacklight::Exceptions::InvalidSolrID
     end
 
@@ -1090,7 +1092,7 @@ describe 'Blacklight::SolrHelper' do
 #  more like this
 #  nearby on shelf
   it "should raise a Blacklight exception if RSolr can't connect to the Solr instance" do
-    Blacklight.solr.stub(:get).and_raise(Errno::ECONNREFUSED)
+    blacklight_solr.stub(:get).and_raise(Errno::ECONNREFUSED)
     expect { find(:a => 123) }.to raise_exception(/Unable to connect to Solr instance/)
   end
 
@@ -1156,7 +1158,7 @@ describe 'Blacklight::SolrHelper' do
 
       it "defaults to get" do
         expect(blacklight_config.http_method).to eq :get
-        Blacklight.solr.should_receive(:send_and_receive) do |path, params|
+        blacklight_solr.should_receive(:send_and_receive) do |path, params|
           expect(path).to eq 'select'
           expect(params[:method]).to eq :get
           expect(params[:params]).to include(:q)
@@ -1170,7 +1172,7 @@ describe 'Blacklight::SolrHelper' do
 
       it "keep value set to post" do
         expect(blacklight_config.http_method).to eq :post
-        Blacklight.solr.should_receive(:send_and_receive) do |path, params|
+        blacklight_solr.should_receive(:send_and_receive) do |path, params|
           expect(path).to eq 'select'
           expect(params[:method]).to eq :post
           expect(params[:data]).to include(:q)

data/spec/lib/utils_spec.rb

@@ -34,12 +34,10 @@ describe 'Blacklight::Utils' do
     describe "internal hash table" do
       before do
         @h = Blacklight::OpenStructWithHashAccess.new
-
         @h[:a] = 1
         @h[:b] = 2
-
-
       end
+
       it "should expose the internal hash table" do
         @h.to_h.should be_a_kind_of(Hash)
         @h.to_h[:a].should == 1
@@ -48,11 +46,43 @@ describe 'Blacklight::Utils' do
       it "should expose keys" do
         @h.keys.should include(:a, :b)
       end
+    end
+
+    describe "#merge" do
+
+      before do
+        @h = Blacklight::OpenStructWithHashAccess.new
+        @h[:a] = 1
+        @h[:b] = 2
+      end
+      
+      it "should merge the object with a hash" do
+        expect(@h.merge(:a => 'a')[:a]).to eq 'a'
+      end
 
-      it "should expose merge" do
-        @h.merge(:a => 'a')[:a].should == 'a'
+      it "should merge the object with another struct" do
+        expect(@h.merge(Blacklight::OpenStructWithHashAccess.new(:a => 'a'))[:a]).to eq 'a'
       end
+    end
 
+
+    describe "#merge!" do
+      
+      before do
+        @h = Blacklight::OpenStructWithHashAccess.new
+        @h[:a] = 1
+        @h[:b] = 2
+      end
+      
+      it "should merge the object with a hash" do
+        @h.merge!(:a => 'a')
+        expect(@h[:a]).to eq 'a'
+      end
+
+      it "should merge the object with another struct" do
+        @h.merge!(Blacklight::OpenStructWithHashAccess.new(:a => 'a'))
+        expect(@h[:a]).to eq 'a'
+      end
     end
   end
 end

data/spec/views/catalog/_paginate_compact.html.erb_spec.rb

@@ -12,7 +12,7 @@ describe "catalog/_paginate_compact.html.erb" do
     end
 
     def blacklight_solr
-      Blacklight.solr
+      Deprecation.silence(Blacklight) { Blacklight.solr }
     end
 
     def facet_limit_for *args

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight
 version: !ruby/object:Gem::Version
-  version: 4.6.3
+  version: 4.7.0.pre1
 platform: ruby
 authors:
 - Jonathan Rochkind
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2014-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -139,16 +139,16 @@ dependencies:
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: jettywrapper
   requirement: !ruby/object:Gem::Requirement
@@ -373,6 +373,47 @@ files:
 - config/locales/blacklight.en.yml
 - config/locales/blacklight.fr.yml
 - config/routes.rb
+- doc/Atom-Responses.md
+- doc/Blacklight-3.0-Release-Notes-And-Upgrade-Guide.md
+- doc/Blacklight-3.2-Release-Notes-and-Upgrade-Guide.md
+- doc/Blacklight-3.3-release-notes-and-upgrade-guide.md
+- doc/Blacklight-3.4-release-notes-and-upgrade-guide.md
+- doc/Blacklight-3.5-release-notes-and-upgrade-guide.md
+- doc/Blacklight-3.6-release-notes-and-upgrade-guide.md
+- doc/Blacklight-3.7-release-notes-and-upgrade-guide.md
+- doc/Blacklight-3.8-release-notes-and-upgrade-guide.md
+- doc/Blacklight-4.0-release-notes-and-upgrade-guide.md
+- doc/Blacklight-4.1-release-notes-and-upgrade-guide.md
+- doc/Blacklight-4.2-release-notes-and-upgrade-guide.md
+- doc/Blacklight-4.3-release-notes-and-upgrade-guide.md
+- doc/Blacklight-4.4-release-notes-and-upgrade-guide.md
+- doc/Blacklight-Add-ons.md
+- doc/Blacklight-configuration.md
+- doc/Blacklight-on-Heroku.md
+- doc/Code4Lib-2014.md
+- doc/Community-principles.md
+- doc/Configuring-and-Customizing-Blacklight.md
+- doc/Configuring-rails-routes.md
+- doc/Contributing-to-Blacklight.md
+- doc/Examples.md
+- doc/Extending-or-Modifying-Blacklight-Search-Behavior.md
+- doc/FAQs.md
+- doc/Home.md
+- doc/How-to-release-a-version.md
+- doc/Indexing-your-data-into-solr.md
+- doc/Integration-with-Rails-Footnotes.md
+- doc/Internationalization.md
+- doc/JSON-API.md
+- doc/Pagination.md
+- doc/Providing-your-own-view-templates.md
+- doc/Quickstart.md
+- doc/README_SOLR.md
+- doc/Release-Notes-And-Upgrade-Guides.md
+- doc/Roadmap.md
+- doc/Sunspot-for-indexing.md
+- doc/Theming.md
+- doc/User-Authentication.md
+- doc/testing.md
 - gemfiles/rails3.gemfile
 - gemfiles/rails4.gemfile
 - lib/SolrMarc.jar
@@ -542,9 +583,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: blacklight
 rubygems_version: 2.2.0