blacklight_iiif_search 1.0.0 → 2.0.0

data/spec/iiif_search_shared.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # shared variables that can be used across specs
 # https://relishapp.com/rspec/rspec-core/docs/example-groups/shared-context
 RSpec.shared_context 'iiif_search_shared' do
@@ -14,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.fetch(parent_id)[1] }
-  let(:page_document) { controller.fetch(page_id)[1] }
+  let(:parent_document) { controller.search_service.fetch(parent_id)[1] }
+  let(:page_document) { controller.search_service.fetch(page_id)[1] }
   let(:repository) { Blacklight::Solr::Repository.new(blacklight_config) }
 
   let(:iiif_search) do

data/spec/models/blacklight_iiif_search/iiif_search_annotation_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'iiif_search_shared'
 RSpec.describe BlacklightIiifSearch::IiifSearchAnnotation do
   include_context 'iiif_search_shared'
@@ -13,24 +15,24 @@ RSpec.describe BlacklightIiifSearch::IiifSearchAnnotation do
   end
 
   describe '#as_hash' do
-    subject { iiif_search_annotation.as_hash }
+    subject(:anno_as_hash) { iiif_search_annotation.as_hash }
     it 'returns the correct object' do
-      expect(subject.class).to eq(IIIF::Presentation::Annotation)
+      expect(anno_as_hash.class).to eq(IIIF::Presentation::Annotation)
     end
     it 'has a text resource' do
-      expect(subject.resource.class).to eq(IIIF::Presentation::Resource)
+      expect(anno_as_hash.resource.class).to eq(IIIF::Presentation::Resource)
     end
     it 'has an "on" property' do
-      expect(subject['on']).not_to be_blank
+      expect(anno_as_hash['on']).not_to be_blank
     end
   end
 
   describe '#text_resource_for_annotation' do
-    subject { iiif_search_annotation.text_resource_for_annotation }
+    subject(:text_resource) { iiif_search_annotation.text_resource_for_annotation }
     it 'returns the correct object' do
-      expect(subject.class).to eq(IIIF::Presentation::Resource)
-      expect(subject['chars']).to include(query_term)
-      expect(subject['chars']).not_to include('<em>')
+      expect(text_resource.class).to eq(IIIF::Presentation::Resource)
+      expect(text_resource['chars']).to include(query_term)
+      expect(text_resource['chars']).not_to include('<em>')
     end
   end
 end

data/spec/models/blacklight_iiif_search/iiif_search_response_spec.rb

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 require 'iiif_search_shared'
 RSpec.describe BlacklightIiifSearch::IiifSearchResponse do
   include_context 'iiif_search_shared'
 
-  let(:solr_response) do
-    controller.search_results(iiif_search.solr_params).first
+  let(:iiif_search_service) 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(:iiif_search_response) do
     described_class.new(solr_response, parent_document, controller)
   end
@@ -16,40 +20,40 @@ RSpec.describe BlacklightIiifSearch::IiifSearchResponse do
   end
 
   describe '#annotation_list' do
-    subject { iiif_search_response.annotation_list }
+    subject(:iiif_anno_list) { iiif_search_response.annotation_list }
 
     it 'returns an OrderedHash' do
-      expect(subject.class).to eq(IIIF::OrderedHash)
+      expect(iiif_anno_list.class).to eq(IIIF::OrderedHash)
     end
 
     it 'has the correct content' do
-      expect(subject['@id']).not_to be_falsey
-      expect(subject['@type']).to eq('sc:AnnotationList')
-      expect(subject['resources']).not_to be_blank
-      expect(subject['within']).not_to be_blank
-      expect(subject['hits']).not_to be_blank
+      expect(iiif_anno_list['@id']).not_to be_falsey
+      expect(iiif_anno_list['@type']).to eq('sc:AnnotationList')
+      expect(iiif_anno_list['resources']).not_to be_blank
+      expect(iiif_anno_list['within']).not_to be_blank
+      expect(iiif_anno_list['hits']).not_to be_blank
     end
 
     let(:hit) { subject['hits'].first }
     it 'has properly formatted search:Hit' do
       expect(hit[:@type]).to eq('search:Hit')
-      expect(hit[:annotations].first).to eq(subject['resources'].first['@id'])
+      expect(hit[:annotations].first).to eq(iiif_anno_list['resources'].first['@id'])
     end
   end
 
   describe '#resources' do
-    subject { iiif_search_response.resources }
+    subject(:response_resources) { iiif_search_response.resources }
     it 'returns an array of IiifSearchAnnotation objects' do
-      expect(subject.length).to eq(2)
-      expect(subject.first.class).to eq(IIIF::Presentation::Annotation)
+      expect(response_resources.length).to eq(2)
+      expect(response_resources.first.class).to eq(IIIF::Presentation::Annotation)
     end
   end
 
   describe '#clean_params' do
-    subject { iiif_search_response.clean_params }
+    subject(:response_params) { iiif_search_response.clean_params }
     it 'returns an array of acceptable parameters' do
-      expect(subject).to include('q')
-      expect(subject).not_to include('date')
+      expect(response_params).to include('q')
+      expect(response_params).not_to include('date')
     end
   end
 
@@ -64,10 +68,10 @@ RSpec.describe BlacklightIiifSearch::IiifSearchResponse do
   end
 
   describe '#within' do
-    subject { iiif_search_response.within }
+    subject(:response_within) { iiif_search_response.within }
     it 'returns a IIIF::Presentation::Layer object' do
-      expect(subject.class).to eq(IIIF::Presentation::Layer)
-      expect(subject['ignored']).to include('date')
+      expect(response_within.class).to eq(IIIF::Presentation::Layer)
+      expect(response_within['ignored']).to include('date')
     end
   end
 end

data/spec/models/blacklight_iiif_search/iiif_search_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'iiif_search_shared'
 RSpec.describe BlacklightIiifSearch::IiifSearch do
   include_context 'iiif_search_shared'

data/spec/models/blacklight_iiif_search/iiif_suggest_response_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'iiif_search_shared'
 RSpec.describe BlacklightIiifSearch::IiifSuggestResponse do
   include_context 'iiif_search_shared'
@@ -9,35 +11,35 @@ RSpec.describe BlacklightIiifSearch::IiifSuggestResponse do
   end
 
   describe '#term_list' do
-    subject { iiif_suggest_response.term_list }
+    subject(:response_term_list) { iiif_suggest_response.term_list }
 
     it 'returns the correct class' do
-      expect(subject.class).to eq(IIIF::OrderedHash)
+      expect(response_term_list.class).to eq(IIIF::OrderedHash)
     end
 
     it 'has the correct content' do
-      expect(subject['@id']).not_to be_falsey
-      expect(subject['@type']).to eq('search:TermList')
-      expect(subject['terms']).not_to be_blank
+      expect(response_term_list['@id']).not_to be_falsey
+      expect(response_term_list['@type']).to eq('search:TermList')
+      expect(response_term_list['terms']).not_to be_blank
     end
   end
 
   describe '#terms' do
-    subject { iiif_suggest_response.terms }
+    subject(:response_terms) { iiif_suggest_response.terms }
 
     it 'returns the expected data' do
-      expect(subject.length).to eq(5)
-      expect(subject.first[:url]).not_to be_falsey
-      expect(subject.first[:match].match(/\A#{suggest_query_term}/)).to be_truthy
+      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
     end
   end
 
   describe '#iiif_search_url' do
-    subject { iiif_suggest_response.iiif_search_url(suggest_query_term) }
+    subject(:response_urls) { iiif_suggest_response.iiif_search_url(suggest_query_term) }
 
     it 'returns a search url' do
-      expect(subject).to include(parent_id)
-      expect(subject).to include(suggest_query_term)
+      expect(response_urls).to include(parent_id)
+      expect(response_urls).to include(suggest_query_term)
     end
   end
 end

data/spec/models/blacklight_iiif_search/iiif_suggest_search_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'iiif_search_shared'
 RSpec.describe BlacklightIiifSearch::IiifSuggestSearch do
   include_context 'iiif_search_shared'
@@ -9,26 +11,26 @@ RSpec.describe BlacklightIiifSearch::IiifSuggestSearch do
   end
 
   describe '#response' do
-    subject { iiif_suggest_search.response }
+    subject(:suggest_response) { iiif_suggest_search.response }
 
     it 'returns the correct class' do
-      expect(subject.class).to eq(IIIF::OrderedHash)
+      expect(suggest_response.class).to eq(IIIF::OrderedHash)
     end
 
     it 'returns the expected data' do
-      expect(subject['terms'].length).to eq(5)
+      expect(suggest_response['terms'].length).to eq(5)
     end
   end
 
   describe '#suggest_results' do
-    subject { iiif_suggest_search.suggest_results }
+    subject(:suggest_results) { iiif_suggest_search.suggest_results }
 
     it 'returns the correct class' do
-      expect(subject.class).to eq(RSolr::HashWithResponse)
+      expect(suggest_results.class).to eq(RSolr::HashWithResponse)
     end
 
     it 'returns the expected data' do
-      terms = subject['suggest'][blacklight_config.iiif_search[:suggester_name]][suggest_query_term]['suggestions']
+      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
     end

data/spec/models/concerns/blacklight_iiif_search/annotation_behavior_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'iiif_search_shared'
 RSpec.describe BlacklightIiifSearch::AnnotationBehavior do
   include_context 'iiif_search_shared'
@@ -9,23 +11,20 @@ RSpec.describe BlacklightIiifSearch::AnnotationBehavior do
   end
 
   describe '#annotation_id' do
-    subject { iiif_search_annotation.annotation_id }
     it 'returns a properly formatted URL' do
-      expect(subject).to include("#{parent_id}/canvas/#{page_id}/annotation/0")
+      expect(iiif_search_annotation.annotation_id).to include("#{parent_id}/canvas/#{page_id}/annotation/0")
     end
   end
 
   describe '#canvas_uri_for_annotation' do
-    subject { iiif_search_annotation.canvas_uri_for_annotation }
     it 'returns a properly formatted URL' do
-      expect(subject).to include("#{parent_id}/canvas/#{page_id}")
+      expect(iiif_search_annotation.canvas_uri_for_annotation).to include("#{parent_id}/canvas/#{page_id}")
     end
   end
 
   describe '#coordinates' do
-    subject { iiif_search_annotation.coordinates }
     it 'returns a coordinate string' do
-      expect(subject).to eq('#xywh=0,0,0,0')
+      expect(iiif_search_annotation.coordinates).to eq('#xywh=0,0,0,0')
     end
   end
 end

data/spec/models/concerns/blacklight_iiif_search/ignored_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'iiif_search_shared'
 RSpec.describe BlacklightIiifSearch::Ignored do
   include_context 'iiif_search_shared'

data/spec/models/concerns/blacklight_iiif_search/search_behavior_spec.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'iiif_search_shared'
 RSpec.describe BlacklightIiifSearch::SearchBehavior do
   include_context 'iiif_search_shared'
 
   describe '#object_relation_solr_params' do
-    subject { iiif_search.object_relation_solr_params }
+    subject(:relation_params) { iiif_search.object_relation_solr_params }
     it 'returns a hash with the correct content' do
-      expect(subject.keys.first).to eq('is_page_of_s')
-      expect(subject.values.first).to eq(parent_id)
+      expect(relation_params.keys.first).to eq('is_page_of_ssi')
+      expect(relation_params.values.first).to eq(parent_id)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # testing environent:
 ENV['RAILS_ENV'] ||= 'test'
 

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 
 class TestAppGenerator < Rails::Generators::Base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blacklight_iiif_search
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Eben English
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-26 00:00:00.000000000 Z
+date: 2020-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,34 +16,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: blacklight
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: iiif-presentation
   requirement: !ruby/object:Gem::Requirement
@@ -90,16 +90,16 @@ dependencies:
   name: engine_cart
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -115,47 +115,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.50.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.50.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: bixby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
-- !ruby/object:Gem::Dependency
-  name: bixby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 description: Blacklight IIIF Search plugin
 email:
 - eenglish@bpl.org
@@ -219,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Blacklight IIIF Search plugin