blacklight_iiif_search 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1db4fcea6de6ad4fbe6c0e5dc49eeb478e472c7fbe2c688ddf30b63d6530369
-  data.tar.gz: 18b6e6b81eb24824db80501def12c7f61c41e0f3ab45971c9e1bd6240b37a3b3
+  metadata.gz: 47f037fe96939a365bf695a81e1a11876b0fe4e6756e2c7cee7a7aaa23ef07df
+  data.tar.gz: be3140c6993352e0dfae2e5f8f014b6a70aea3fa9f9b39311d0bd171cf2bcda8
 SHA512:
-  metadata.gz: c62ff646af27bc6ea4a76d91f6863ea866c960b140ce3a8df7c2556e24792ed3398c913e4ce65367d957971b3a44793a1961932a4b29c651cbb7cca71a09511f
-  data.tar.gz: 626f89bb255bb7e431f02b7c198ca0c36bcefcbeec595841701db515c4e4e6217aeabae8f7adbe4d17e698b9b29256ea185e2add6bc8b24c0e6e55e6c8a30047
+  metadata.gz: a2fc141a9539fdd448c531ef69d8d93fc72919832dd256cdc5a988a7e3360f0241d4cde8ade9b7f4e800972e8288bc87109d3e2ad39f737cc563db11989e3b1e
+  data.tar.gz: 2c4c822c8304d444b1f0533153dbe49a9a07fb8b995f97e33bdeb72b501b06e4eadf72805ed540b6870847b074be8a6fc1658980f2e37200f6593e189aa0ec66

data/Rakefile

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rubygems'
+require 'rails'
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -36,8 +38,11 @@ RuboCop::RakeTask.new(:rubocop)
 desc 'Run test suite'
 task ci: [:rubocop, 'engine_cart:generate'] do
   SolrWrapper.wrap do |solr|
-    FileUtils.cp File.join(__dir__, 'lib', 'generators', 'blacklight_iiif_search', 'templates', 'solr', 'lib', 'tokenizing-suggest-v1.0.1.jar'),
-                 File.join(solr.instance_dir, 'contrib')
+    # single-term autocomplete via tokenizing-suggest currently requires Solr 7.*, see README.md for more info
+    if solr.version.to_f < 8
+      FileUtils.cp(File.join(__dir__, 'lib', 'generators', 'blacklight_iiif_search', 'templates', 'solr', 'lib', 'tokenizing-suggest-v1.0.1.jar'),
+                   File.join(solr.instance_dir, 'contrib'))
+    end
     solr.with_collection do
       within_test_app do
         system 'RAILS_ENV=test rake blacklight_iiif_search:index:seed'

data/app/controllers/concerns/blacklight_iiif_search/controller.rb

@@ -11,23 +11,19 @@ module BlacklightIiifSearch
     end
 
     def iiif_search
-      _parent_response, @parent_document = search_service.fetch(params[:solr_document_id])
-      iiif_search = IiifSearch.new(iiif_search_params, iiif_search_config,
-                                   @parent_document)
+      @parent_document = search_service.fetch(params[:solr_document_id])
+      iiif_search = IiifSearch.new(iiif_search_params, iiif_search_config, @parent_document)
       iiif_search_service = search_service_class.new(config: blacklight_config,
                                                      user_params: iiif_search.solr_params)
-      @response, _document_list = iiif_search_service.search_results
-      iiif_search_response = IiifSearchResponse.new(@response,
-                                                    @parent_document,
-                                                    self)
-      render json: iiif_search_response.annotation_list,
-             content_type: 'application/json'
+      @response = iiif_search_service.search_results
+      iiif_search_response = IiifSearchResponse.new(@response, @parent_document, self)
+
+      render json: iiif_search_response.annotation_list, content_type: 'application/json'
     end
 
     def iiif_suggest
       suggest_search = IiifSuggestSearch.new(params, Blacklight.default_index, self)
-      render json: suggest_search.response,
-             content_type: 'application/json'
+      render json: suggest_search.response, content_type: 'application/json'
     end
 
     def iiif_search_config

data/lib/blacklight_iiif_search/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlacklightIiifSearch
-  VERSION = '2.1.0'
+  VERSION = '3.0.0'
 end

data/lib/generators/blacklight_iiif_search/install_generator.rb

@@ -18,13 +18,14 @@ module BlacklightIiifSearch
        1. Injects behavior into CatalogController
        2. Adds a SearchBuilder to ./app/models
        3. Adds BlacklightIiifSearch routes to ./config/routes.rb
-       4. Modifies solrconfig.xml to support contextual autocomplete functionality
+       4. Modifies Solr schema.xml and solrconfig.xml to support contextual autocomplete functionality
       Thanks for installing Blacklight IIIF Search!
     EOS
 
     def verify_blacklight_installed
       return if IO.read('app/controllers/application_controller.rb').include?('include Blacklight::Controller')
       say_status('info', 'BLACKLIGHT NOT INSTALLED; GENERATING BLACKLIGHT', :blue)
+
       generate 'blacklight:install'
     end
 
@@ -45,7 +46,7 @@ module BlacklightIiifSearch
     end
 
     def bundle_install
-      Bundler.with_clean_env do
+      Bundler.with_unbundled_env do
         run 'bundle install'
       end
     end

data/lib/generators/blacklight_iiif_search/routes_generator.rb

@@ -10,7 +10,7 @@ module BlacklightIiifSearch
     desc 'This generator makes the following changes to your app:
         1. Injects route declarations into your routes.rb'
 
-    # Add CommonwealthVlrEngine to the routes
+    # Add BlacklightIiifSearch to the routes
     def inject_iiif_search_routes
       return if IO.read('config/routes.rb').include?('BlacklightIiifSearch::Routes')
 

data/lib/generators/blacklight_iiif_search/solr_generator.rb

@@ -16,18 +16,22 @@ module BlacklightIiifSearch
       marker = '</config>'
       inject_into_file 'solr/conf/solrconfig.xml', before: marker do
         "  <!-- BEGIN Blacklight IIIF Search autocomplete config -->
-  <!-- solr-tokenizing_suggester is necessary to return single terms from the suggester -->
-  <lib dir=\"${solr.install.dir:../../../..}/contrib\" regex=\"tokenizing-suggest-v1.0.1.jar\" />\n
+  <!-- tokenizing-suggest is necessary to return only single terms from the suggester -->
+  <!-- to use this, copy the blacklight_iiif_search/lib/generators/blacklight_iiif_search/templates/solr/lib/tokenizing-suggest-v1.0.1.jar -->
+  <!-- to your Solr install's contrib directory, and uncomment the lines below. -->
+  <!-- HOWEVER, this only works in Solr 7.*, see blacklight_iiif_search README for more info. -->
+  <!-- <lib dir=\"${solr.install.dir:../../../..}/contrib\" regex=\"tokenizing-suggest-v1.0.1.jar\" /> -->
   <searchComponent name=\"iiif_suggest\" class=\"solr.SuggestComponent\">
     <lst name=\"suggester\">
       <str name=\"name\">iiifSuggester</str>
-      <str name=\"lookupImpl\">edu.stanford.dlss.search.suggest.analyzing.TokenizingLookupFactory</str>
+      <str name=\"lookupImpl\">AnalyzingInfixLookupFactory</str>
       <str name=\"dictionaryImpl\">DocumentDictionaryFactory</str>
       <str name=\"suggestAnalyzerFieldType\">textSuggest</str>
-      <str name=\"suggestTokenizingAnalyzerFieldType\">textSuggestTokenizer</str>
       <str name=\"contextField\">is_page_of_ssi</str>
       <str name=\"buildOnCommit\">true</str>
       <str name=\"field\">iiif_suggest</str>
+      <!-- <str name=\"lookupImpl\">edu.stanford.dlss.search.suggest.analyzing.TokenizingLookupFactory</str> -->
+      <!-- <str name=\"suggestTokenizingAnalyzerFieldType\">textSuggestTokenizer</str> -->
     </lst>
   </searchComponent>\n
   <requestHandler name=\"/iiif_suggest\" class=\"solr.SearchHandler\" startup=\"lazy\">
@@ -51,6 +55,8 @@ module BlacklightIiifSearch
       field_type_marker = '</types>'
       inject_into_file filepath, before: field_type_marker do
         "\n    <!-- BEGIN Blacklight IIIF Search autocomplete config -->
+    <!-- textSuggestTokenizer is only used by edu.stanford.dlss.search.suggest.analyzing.TokenizingLookupFactory -->
+    <!-- this fieldType can be ignored if using Solr > 7, see blacklight_iiif_search README for more info. -->
     <fieldType name=\"textSuggestTokenizer\" class=\"solr.TextField\" positionIncrementGap=\"100\">
       <analyzer>
         <tokenizer class=\"solr.WhitespaceTokenizerFactory\"/>
@@ -79,6 +85,15 @@ module BlacklightIiifSearch
   <copyField source=\"all_text_timv\" dest=\"iiif_suggest\"/>
   <!-- END Blacklight IIIF Search autocomplete config -->\n\n"
       end
+
+      textsuggest_marker = /<fieldType[\s]*name="textSuggest"[^>]*>[\s]*<analyzer>[\s]*<tokenizer class="solr.KeywordTokenizerFactory"\/>/
+      gsub_file(filepath, textsuggest_marker) do
+        "<fieldType name=\"textSuggest\" class=\"solr.TextField\" positionIncrementGap=\"100\">
+      <analyzer>
+        <!-- Blacklight IIIF Search autocomplete suggester config requires StandardTokenizerFactory -->
+        <!-- <tokenizer class=\"solr.KeywordTokenizerFactory\"/> -->
+        <tokenizer class=\"solr.StandardTokenizerFactory\"/>"
+      end
     end
 
     def copy_suggester_library

data/spec/iiif_search_shared.rb

@@ -16,8 +16,8 @@ RSpec.shared_context 'iiif_search_shared' do
   let(:suggest_search_params) do
     { q: suggest_query_term, solr_document_id: parent_id, date: 'foo' }
   end
-  let(:parent_document) { controller.search_service.fetch(parent_id)[1] }
-  let(:page_document) { controller.search_service.fetch(page_id)[1] }
+  let(:parent_document) { controller.search_service.fetch(parent_id) }
+  let(:page_document) { controller.search_service.fetch(page_id) }
   let(:repository) { Blacklight::Solr::Repository.new(blacklight_config) }
 
   let(:iiif_search) do

data/spec/models/blacklight_iiif_search/iiif_search_response_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe BlacklightIiifSearch::IiifSearchResponse do
     controller.search_service_class.new(config: blacklight_config,
                                         user_params: iiif_search.solr_params)
   end
-  let(:solr_response) { iiif_search_service.search_results.first }
+  let(:solr_response) { iiif_search_service.search_results }
   let(:iiif_search_response) do
     described_class.new(solr_response, parent_document, controller)
   end

data/spec/models/blacklight_iiif_search/iiif_suggest_response_spec.rb

@@ -30,7 +30,7 @@ RSpec.describe BlacklightIiifSearch::IiifSuggestResponse do
     it 'returns the expected data' do
       expect(response_terms.length).to eq(5)
       expect(response_terms.first[:url]).not_to be_falsey
-      expect(response_terms.first[:match].match(/\A#{suggest_query_term}/)).to be_truthy
+      expect(response_terms.first[:match].match(/#{suggest_query_term}/)).to be_truthy
     end
   end
 

data/spec/models/blacklight_iiif_search/iiif_suggest_search_spec.rb

@@ -32,7 +32,7 @@ RSpec.describe BlacklightIiifSearch::IiifSuggestSearch do
     it 'returns the expected data' do
       terms = suggest_results['suggest'][blacklight_config.iiif_search[:suggester_name]][suggest_query_term]['suggestions']
       expect(terms.length).to eq(5)
-      expect(terms.first['term'].match(/\A#{suggest_query_term}/)).to be_truthy
+      expect(terms.first['term'].match(/#{suggest_query_term}/)).to be_truthy
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_iiif_search
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Eben English
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 2024-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,34 +16,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.3'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.3'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: iiif-presentation
   requirement: !ruby/object:Gem::Requirement
@@ -76,16 +76,22 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: solr_wrapper
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +140,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: '5.0'
 description: Blacklight IIIF Search plugin
 email:
 - eenglish@bpl.org
@@ -169,7 +175,6 @@ files:
 - lib/generators/blacklight_iiif_search/routes_generator.rb
 - lib/generators/blacklight_iiif_search/solr_generator.rb
 - lib/generators/blacklight_iiif_search/templates/iiif_search_builder.rb
-- lib/generators/blacklight_iiif_search/templates/solr/lib/solr-tokenizing_suggester-7.x.jar
 - lib/generators/blacklight_iiif_search/templates/solr/lib/tokenizing-suggest-v1.0.1.jar
 - lib/railties/blacklight_iiif_search.rake
 - spec/controllers/catalog_controller_spec.rb
@@ -191,7 +196,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/boston-library/blacklight_iiif_search
   source_code_uri: https://github.com/boston-library/blacklight_iiif_search
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -199,15 +204,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.3.27
+signing_key: 
 specification_version: 4
 summary: Blacklight IIIF Search plugin
 test_files: