blacklight_iiif_search 0.0.1.pre.alpha

data/spec/iiif_search_shared.rb

@@ -0,0 +1,49 @@
+# 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
+  let(:parent_id) { '7s75dn48d' }
+  let(:page_id) { '7s75dn58n' }
+  let(:query_term) { 'sugar' }
+  let(:suggest_query_term) { 'be' }
+  let(:snippet) { 'Twelve pounds of <em>sugar</em>, two quarts of water' }
+  let(:controller) { CatalogController.new }
+  let(:blacklight_config) { controller.blacklight_config }
+  let(:search_params) do
+    { q: query_term, solr_document_id: parent_id, date: 'foo' }
+  end
+  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(:repository) { Blacklight::Solr::Repository.new(blacklight_config) }
+
+  let(:iiif_search) do
+    BlacklightIiifSearch::IiifSearch.new(search_params,
+                                         blacklight_config.iiif_search,
+                                         parent_document)
+  end
+
+  let(:iiif_suggest_search) do
+    BlacklightIiifSearch::IiifSuggestSearch.new(suggest_search_params,
+                                                repository,
+                                                controller)
+  end
+
+  let(:iiif_suggest_response) do
+    BlacklightIiifSearch::IiifSuggestResponse.new(iiif_suggest_search.suggest_results,
+                                                  suggest_search_params,
+                                                  controller)
+  end
+
+  before do
+    controller.params = search_params
+    blacklight_config.search_builder_class = IiifSearchBuilder
+    controller.request = ActionDispatch::TestRequest.new(env: :test,
+                                                         host: 'http://0.0.0.0')
+  end
+end
+
+RSpec.configure do |rspec|
+  rspec.include_context 'iiif_search_shared', include_shared: true
+end

data/spec/models/blacklight_iiif_search/iiif_search_annotation_spec.rb

@@ -0,0 +1,36 @@
+require 'iiif_search_shared'
+RSpec.describe BlacklightIiifSearch::IiifSearchAnnotation do
+  include_context 'iiif_search_shared'
+
+  let(:iiif_search_annotation) do
+    described_class.new(page_document, query_term, 0, snippet, controller, parent_document)
+  end
+
+  describe 'class' do
+    it 'is a IiifSearchAnnotation' do
+      expect(iiif_search_annotation.class).to eq(described_class)
+    end
+  end
+
+  describe '#as_hash' do
+    subject { iiif_search_annotation.as_hash }
+    it 'returns the correct object' do
+      expect(subject.class).to eq(IIIF::Presentation::Annotation)
+    end
+    it 'has a text resource' do
+      expect(subject.resource.class).to eq(IIIF::Presentation::Resource)
+    end
+    it 'has an "on" property' do
+      expect(subject['on']).not_to be_blank
+    end
+  end
+
+  describe '#text_resource_for_annotation' do
+    subject { 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>')
+    end
+  end
+end

data/spec/models/blacklight_iiif_search/iiif_search_response_spec.rb

@@ -0,0 +1,73 @@
+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
+  end
+  let(:iiif_search_response) do
+    described_class.new(solr_response, parent_document, controller)
+  end
+
+  describe 'class' do
+    it 'is a IiifSearchResponse' do
+      expect(iiif_search_response.class).to eq(described_class)
+    end
+  end
+
+  describe '#annotation_list' do
+    subject { iiif_search_response.annotation_list }
+
+    it 'returns an OrderedHash' do
+      expect(subject.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
+    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'])
+    end
+  end
+
+  describe '#resources' do
+    subject { 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)
+    end
+  end
+
+  describe '#clean_params' do
+    subject { iiif_search_response.clean_params }
+    it 'returns an array of acceptable parameters' do
+      expect(subject).to include('q')
+      expect(subject).not_to include('date')
+    end
+  end
+
+  # TODO: fix ActionController::UrlGenerationError:
+  # No route matches {:action=>"iiif_search", :controller=>"catalog", "page"=>100, "q"=>"teachers"},
+  # missing required keys: [:solr_document_id]
+  # this method calls solr_document_iiif_search_url
+  # missing :solr_document_id only seems to be an issue with the spec
+  describe '#paged_url' do
+    it 'returns a solr_document URL with the page param'
+    # expect(iiif_search_response.paged_url(100)).to include('page=100')
+  end
+
+  describe '#within' do
+    subject { 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')
+    end
+  end
+end

data/spec/models/blacklight_iiif_search/iiif_search_spec.rb

@@ -0,0 +1,23 @@
+require 'iiif_search_shared'
+RSpec.describe BlacklightIiifSearch::IiifSearch do
+  include_context 'iiif_search_shared'
+
+  describe 'class' do
+    it 'is an IiifSearch' do
+      expect(iiif_search.class).to eq(described_class)
+    end
+  end
+
+  describe '#solr_params' do
+    it 'responds to #solr_params' do
+      expect(iiif_search).to respond_to(:solr_params)
+    end
+
+    it 'returns a hash of parameters' do
+      solr_params = iiif_search.solr_params
+      expect(solr_params[:q]).to eq(query_term)
+      expect(solr_params[:rows]).to eq(iiif_search.rows)
+      expect(solr_params[:f]).not_to be_nil
+    end
+  end
+end

data/spec/models/blacklight_iiif_search/iiif_suggest_response_spec.rb

@@ -0,0 +1,43 @@
+require 'iiif_search_shared'
+RSpec.describe BlacklightIiifSearch::IiifSuggestResponse do
+  include_context 'iiif_search_shared'
+
+  describe 'class' do
+    it 'is an IiifSuggestResponse' do
+      expect(iiif_suggest_response.class).to eq(described_class)
+    end
+  end
+
+  describe '#term_list' do
+    subject { iiif_suggest_response.term_list }
+
+    it 'returns the correct class' do
+      expect(subject.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
+    end
+  end
+
+  describe '#terms' do
+    subject { 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
+    end
+  end
+
+  describe '#iiif_search_url' do
+    subject { 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)
+    end
+  end
+end

data/spec/models/blacklight_iiif_search/iiif_suggest_search_spec.rb

@@ -0,0 +1,36 @@
+require 'iiif_search_shared'
+RSpec.describe BlacklightIiifSearch::IiifSuggestSearch do
+  include_context 'iiif_search_shared'
+
+  describe 'class' do
+    it 'is an IiifSuggestSearch' do
+      expect(iiif_suggest_search.class).to eq(described_class)
+    end
+  end
+
+  describe '#response' do
+    subject { iiif_suggest_search.response }
+
+    it 'returns the correct class' do
+      expect(subject.class).to eq(IIIF::OrderedHash)
+    end
+
+    it 'returns the expected data' do
+      expect(subject['terms'].length).to eq(5)
+    end
+  end
+
+  describe '#suggest_results' do
+    subject { iiif_suggest_search.suggest_results }
+
+    it 'returns the correct class' do
+      expect(subject.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']
+      expect(terms.length).to eq(5)
+      expect(terms.first['term'].match(/\A#{suggest_query_term}/)).to be_truthy
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require 'iiif_search_shared'
+RSpec.describe BlacklightIiifSearch::AnnotationBehavior do
+  include_context 'iiif_search_shared'
+
+  let(:iiif_search_annotation) do
+    BlacklightIiifSearch::IiifSearchAnnotation.new(page_document, query_term,
+                                                   0, snippet, controller,
+                                                   parent_document)
+  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")
+    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}")
+    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')
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+require 'iiif_search_shared'
+RSpec.describe BlacklightIiifSearch::Ignored do
+  include_context 'iiif_search_shared'
+
+  describe '#ignored' do
+    it 'returns an array of ignored parameters' do
+      expect(iiif_suggest_response.ignored).to include('date')
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+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 }
+    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)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# testing environent:
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'coveralls'
+Coveralls.wear!
+
+# engine_cart:
+require 'bundler/setup'
+require 'engine_cart'
+EngineCart.load_application!
+
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

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

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+class TestAppGenerator < Rails::Generators::Base
+  source_root './spec/test_app_templates'
+
+  # if you need to generate any additional configuration
+  # into the test app, this generator will be run immediately
+  # after setting up the application
+
+  def install_engine
+    generate 'blacklight_iiif_search:install'
+  end
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: blacklight_iiif_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.alpha
+platform: ruby
+authors:
+- Eben English
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: blacklight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: iiif-presentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: solr_wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.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'
+description: Blacklight IIIF Search plugin
+email:
+- eenglish@bpl.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- app/controllers/concerns/blacklight_iiif_search/controller.rb
+- app/models/blacklight_iiif_search/iiif_search.rb
+- app/models/blacklight_iiif_search/iiif_search_annotation.rb
+- app/models/blacklight_iiif_search/iiif_search_response.rb
+- app/models/blacklight_iiif_search/iiif_suggest_response.rb
+- app/models/blacklight_iiif_search/iiif_suggest_search.rb
+- app/models/concerns/blacklight_iiif_search/annotation_behavior.rb
+- app/models/concerns/blacklight_iiif_search/ignored.rb
+- app/models/concerns/blacklight_iiif_search/search_behavior.rb
+- lib/blacklight_iiif_search.rb
+- lib/blacklight_iiif_search/engine.rb
+- lib/blacklight_iiif_search/routes.rb
+- lib/blacklight_iiif_search/version.rb
+- lib/generators/blacklight_iiif_search/controller_generator.rb
+- lib/generators/blacklight_iiif_search/install_generator.rb
+- lib/generators/blacklight_iiif_search/model_generator.rb
+- 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/railties/blacklight_iiif_search.rake
+- spec/controllers/catalog_controller_spec.rb
+- spec/fixtures/sample_solr_documents.yml
+- spec/iiif_search_shared.rb
+- spec/models/blacklight_iiif_search/iiif_search_annotation_spec.rb
+- spec/models/blacklight_iiif_search/iiif_search_response_spec.rb
+- spec/models/blacklight_iiif_search/iiif_search_spec.rb
+- spec/models/blacklight_iiif_search/iiif_suggest_response_spec.rb
+- spec/models/blacklight_iiif_search/iiif_suggest_search_spec.rb
+- spec/models/concerns/blacklight_iiif_search/annotation_behavior_spec.rb
+- spec/models/concerns/blacklight_iiif_search/ignored_spec.rb
+- spec/models/concerns/blacklight_iiif_search/search_behavior_spec.rb
+- spec/spec_helper.rb
+- spec/test_app_templates/lib/generators/test_app_generator.rb
+homepage: http://projectblacklight.org/
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Blacklight IIIF Search plugin
+test_files:
+- spec/iiif_search_shared.rb
+- spec/models/blacklight_iiif_search/iiif_suggest_response_spec.rb
+- spec/models/blacklight_iiif_search/iiif_search_spec.rb
+- spec/models/blacklight_iiif_search/iiif_search_response_spec.rb
+- spec/models/blacklight_iiif_search/iiif_suggest_search_spec.rb
+- spec/models/blacklight_iiif_search/iiif_search_annotation_spec.rb
+- spec/models/concerns/blacklight_iiif_search/ignored_spec.rb
+- spec/models/concerns/blacklight_iiif_search/search_behavior_spec.rb
+- spec/models/concerns/blacklight_iiif_search/annotation_behavior_spec.rb
+- spec/spec_helper.rb
+- spec/fixtures/sample_solr_documents.yml
+- spec/test_app_templates/lib/generators/test_app_generator.rb
+- spec/controllers/catalog_controller_spec.rb