krikri 0.4.0 → 0.5.0

data/spec/models/provider_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe Krikri::Provider do
+  let(:local_name) { '123' }
+
+  let(:provider) do
+    provider = Krikri::Provider.new(local_name)
+    provider.providedLabel = "moomin"
+    provider
+  end
+
+  let(:agg) do
+    a = build(:aggregation, :provider => provider)
+    a.set_subject! 'moomin'
+    a
+  end
+
+  shared_context 'with indexed item' do
+    before do
+      agg.save
+      indexer = Krikri::QASearchIndex.new
+      indexer.add(agg.to_jsonld['@graph'].first)
+      indexer.commit
+    end
+
+    after do
+      indexer = Krikri::QASearchIndex.new
+      indexer.delete_by_query(['*:*'])
+      indexer.commit
+    end
+  end
+
+  describe '.all' do
+    it 'with no items is empty' do
+      expect(described_class.all).to be_empty
+    end
+
+    context 'with item' do
+      include_context 'with indexed item'
+
+      it 'returns all items' do
+        # todo: ActiveTriples::Resource equality needs work
+        expect(described_class.all.map(&:rdf_subject))
+          .to contain_exactly provider.rdf_subject
+      end
+    end
+
+    context 'with bnode provider' do
+      include_context 'with indexed item'
+
+      let(:provider) { DPLA::MAP::Agent.new }
+
+      it 'ignores bnodes' do
+        expect(described_class.all).to be_empty
+      end
+    end
+  end
+
+  describe '.find' do
+    include_context 'with indexed item'
+
+    it 'finds the provider' do
+      expect(described_class.find(local_name)).to eq provider
+    end
+
+    it 'populates graph' do
+      expect(described_class.find(local_name).count)
+        .to eq provider.count
+    end
+
+    it 'returns property values' do
+      expect(described_class.find(local_name).providedLabel)
+        .to eq provider.providedLabel
+    end
+  end
+
+  describe '#records' do
+    include_context 'with indexed item'
+
+    it 'gives the record' do
+      # @todo fix once {ActiveTriples::RDFSource} equality is figured out
+      expect(provider.records.map(&:rdf_subject))
+        .to contain_exactly agg.rdf_subject
+    end
+  end
+
+  describe '#id' do
+    it 'gives a valid id for initializing resource' do
+      expect(Krikri::Provider.new(provider.id).rdf_subject)
+        .to eq provider.rdf_subject
+    end
+
+    it 'does not include the base uri' do
+      expect(provider.id).not_to include provider.base_uri
+    end
+  end
+
+  describe '#provider_name' do
+    it 'gives prefLabel if present' do
+      provider.label = 'littly my'
+      expect(provider.provider_name).to eq provider.label.first
+    end
+
+    it 'with multiple labels gives just one' do
+      provider.label = ['little my', 'snork']
+      expect(provider.provider_name).to eq provider.label.first
+    end
+
+    it 'gives providedLabel if no prefLabel present' do
+      expect(provider.provider_name).to eq provider.providedLabel.first
+    end
+
+    it 'gives `#id` with with no labels' do
+      provider.label = nil
+      provider.providedLabel = nil
+      expect(provider.provider_name).to eq provider.id
+    end
+  end
+end

data/spec/models/qa_report_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Krikri::QAReport do
+
+  subject { described_class.new(:provider => provider.id.to_s) }
+
+  let(:provider) do
+    agent = build(:agent)
+    agent.set_subject! 'http://example.org/moomin'
+    agent
+  end
+
+  let(:solutions) do
+    RDF::Query::Solutions.new(
+      [RDF::Query::Solution.new(value: RDF::Literal('abc'),
+                                aggregation: DPLA::MAP::Aggregation
+                                  .new('too-ticki').to_term,
+                                isShownAt: DPLA::MAP::WebResource
+                                  .new('http://example.org/too-ticki').to_term),
+       RDF::Query::Solution.new(value: RDF::Literal('abc'),
+                                aggregation: DPLA::MAP::Aggregation
+                                  .new('little-my').to_term,
+                                isShownAt: DPLA::MAP::WebResource
+                                  .new('http://example.org/little-my').to_term),
+       RDF::Query::Solution.new(value: RDF::Literal('123'),
+                                aggregation: DPLA::MAP::Aggregation
+                                  .new('moomin-mama').to_term,
+                                isShownAt: DPLA::MAP::WebResource
+                                  .new('http://example.org/moomin-mama')
+                                  .to_term)])
+  end
+
+  shared_context 'with multiple aggregations' do
+    before do
+      agg = build(:aggregation)
+      agg.set_subject!('mummi123')
+      agg.provider = provider
+      agg.save
+      agg2 = build(:aggregation)
+      agg2.set_subject!('mummi223')
+      agg2.provider = provider
+      agg2.save
+    end
+  end
+
+  describe '#provider' do
+    it 'is set on initalization' do
+      expect(subject.provider).to eq provider.rdf_subject.to_s
+    end
+  end
+
+  describe '#build_provider' do
+    it 'gives a provider' do
+      expect(subject.build_provider).to be_a Krikri::Provider
+    end
+
+    it 'gives provider with correct uri' do
+      expect(subject.build_provider.rdf_subject).to eq provider.rdf_subject
+    end
+  end
+
+
+  describe '#generate_field_report!' do
+    it 'populates report with hash' do
+      subject.generate_field_report!
+      expect(subject.field_report).to be_a Hash
+    end
+
+    it 'generates data for all fields'
+  end
+
+  describe '#generate_count_report!' do
+
+    it 'populates report with hash' do
+      subject.generate_count_report!
+      expect(subject.count_report).to be_a Hash
+    end
+
+    it 'generates count data for all fields'
+  end
+
+  describe '#solutions_to_hash' do
+    it 'gives empty result for empty solution set' do
+      expect(subject.send(:solutions_to_hash, RDF::Query::Solutions.new([])))
+        .to be_empty
+    end
+
+    it 'gives a hash for the solution set' do
+      expect(subject.send(:solutions_to_hash, solutions)).to be_a Hash
+    end
+
+    it 'gives a hash with solution keys' do
+      expect(subject.send(:solutions_to_hash, solutions).keys)
+        .to contain_exactly(*solutions.bindings[:value].uniq)
+    end
+
+    it 'gives a hash with solution keys' do
+      hash = subject.send(:solutions_to_hash, solutions)
+      expect(hash['abc'].count).to eq 2
+    end
+  end
+end

data/spec/models/validation_report_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Krikri::ValidationReport do
+  include_context 'with indexed item'
+
+  # @todo: need more tests for ValidationReport#all
+  describe `#all` do
+    it 'returns facet for each required field' do
+      count = described_class::REQUIRED_FIELDS.count
+      facet_field_const = Blacklight::SolrResponse::Facets::FacetField
+      fields = Array.new(count, an_instance_of(facet_field_const))
+
+      expect(subject.all).to contain_exactly(*fields)
+    end
+  end
+
+  # @todo: need more tests for ValidationReport#find
+  describe `#find` do
+    it 'gives a blacklight solr response' do
+      expect(subject.find('sourceResource_title'))
+        .to be_a Blacklight::SolrResponse
+    end
+
+    it 'raises an error for invalid fields' do
+      expect { subject.find('notA_field') }
+        .to raise_error RSolr::Error::Http
+    end
+
+    it 'gets by provider_id' do
+      provider_uri = RDF::URI(Krikri::Settings.prov.provider_base) / '123'
+      params = { :qt => 'standard',
+                 :q => '-sourceResource_title:[* TO *]',
+                 :rows => '10',
+                 :fq => "provider_id:\"#{provider_uri}\"" }
+
+
+      response = double('solr response')
+      allow(Krikri::SolrResponseBuilder).to receive(:new).with(params)
+                                             .and_return(response)
+      allow(response).to receive(:response).and_return(:result)
+
+      result = subject.find('sourceResource_title') do
+        self.provider_id = '123'
+      end
+
+      expect(result).to eq :result
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -47,12 +47,20 @@ RSpec.configure do |config|
     Krikri::Repository.clear!
   end
 
+  def clear_search_index
+    indexer = Krikri::QASearchIndex.new
+    indexer.delete_by_query(['*:*'])
+    indexer.commit
+  end
+
   config.before(:suite) do
     clear_repository
+    clear_search_index
   end
 
   config.after(:suite) do
     clear_repository
+    clear_search_index
     WebMock.disable_net_connect!(:allow => 'codeclimate.com')
   end
 end

data/spec/support/shared_contexts/entities_query.rb

@@ -0,0 +1,22 @@
+
+##
+# Shared context for queries that find entities (i.e. records) affected
+# by an Activity.
+#
+# See 'provenance queries' shared context
+#
+shared_context 'entities query' do
+  # aggregation comes from lib/dpla/map/factories.rb in DPLA::MAP
+  let(:aggregation) { build(:aggregation) }
+
+  before do
+    DatabaseCleaner.clean_with(:truncation)
+    create(:krikri_harvest_activity)
+    create(:krikri_mapping_activity)
+    create(:krikri_enrichment_activity)
+    allow(DPLA::MAP::Aggregation).to receive(:new)
+      .with(solution.record.to_s)
+      .and_return(aggregation)
+    allow(aggregation).to receive(:get).and_return(true)
+  end
+end

data/spec/support/shared_contexts/indexed_item.rb

@@ -0,0 +1,27 @@
+shared_context 'with indexed item' do
+  include_context 'clear repository'
+
+  before do
+    clear_search_index
+    indexer = Krikri::QASearchIndex.new
+    indexer.add agg.to_jsonld['@graph'].first
+    indexer.commit
+  end
+
+  after do
+    clear_search_index
+  end
+
+  let(:agg) do
+    a = build(:aggregation)
+    a.provider = provider
+    a.set_subject! 'moomin'
+    a
+  end
+
+  let(:provider) do
+    build(:krikri_provider,
+          rdf_subject: 'moomin_valley',
+          label: 'moomin valley')
+  end
+end

data/spec/support/shared_contexts/provenance_query_client.rb

@@ -1,12 +1,25 @@
+
+##
+# Shared context for activities that enumerate their generated entities.
+#
+# To use, define in your example:
+#   - generator_uri [String] URI that corresponds to the ID of your activity
+#
 shared_context 'provenance queries' do
   let(:query) { double('RDF::Query') }
-  let(:solution) { double('RDF::Solution') }
+  let(:solution) { double('RDF::Query::Solution') }
+  let(:solution_enum) do
+    Enumerator.new do |e|
+      e.yield solution
+    end
+  end
   let(:uri) { double('result uri') }
 
   before do
     allow(Krikri::ProvenanceQueryClient).to receive(:find_by_activity)
-      .with(generator_uri).and_return(query)
+      .with(RDF::URI(generator_uri)).and_return(query)
     allow(query).to receive(:execute).and_return([solution])
+    allow(query).to receive(:each_solution).and_return(solution_enum)
     allow(solution).to receive(:record).and_return(uri)
   end
 end

data/spec/views/krikri/providers/index.html.erb_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'krikri/providers/index.html.erb', type: :view do
+  before do
+    assign(:providers, providers)
+    link_texts = providers.map { |p| "#{p.id}_LINK" }
+    allow(view).to receive(:link_to).and_return(*link_texts)
+  end
+
+  let(:providers) do
+    [build(:krikri_provider, rdf_subject: 123),
+     build(:krikri_provider,
+           rdf_subject: 'TooTickyLibrary',
+           label: 'Too-Ticky')]
+  end
+
+  it 'renders each provider' do
+    render
+    providers.each do |provider|
+      expect(rendered).to include "#{provider.id}_LINK"
+    end
+  end
+end

data/spec/views/krikri/providers/show.html.erb_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe 'krikri/providers/show.html.erb', type: :view do
+  before { assign(:current_provider, provider) }
+
+  let(:provider) { build(:krikri_provider) }
+
+  it 'displays provider name' do
+    render
+    expect(rendered).to include provider.label.first.to_s
+  end
+
+  it 'links to records' do
+    render
+    expect(rendered).to include "#{krikri.records_path}?provider=#{provider.id}"
+  end
+
+  it 'links to reports' do
+    render
+    expect(rendered).to include "#{krikri.reports_path}?provider=#{provider.id}"
+  end
+end

data/spec/views/krikri/qa_reports/index.html.erb_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe 'krikri/qa_reports/index.html.erb', type: :view do
+  let(:reports) { [double, double] }
+  let(:provider) { build(:krikri_provider) }
+
+  before do
+    reports.each_with_index do |report, i|
+      allow(report).to receive(:id).and_return(i.to_s)
+      allow(report).to receive(:build_provider)
+                        .and_return(provider)
+
+      allow(view).to receive(:qa_report_path).with(report, format: 'csv')
+                      .and_return("report#{i}_csv_link")
+
+      allow(view).to receive(:qa_report_path)
+                      .with(report, format: 'csv', type: 'count')
+                      .and_return("report#{i}_count_csv_link")
+    end
+
+    assign(:reports, reports)
+  end
+
+  it 'gives provider by name' do
+    render
+    expect(rendered).to include view.provider_name(provider)
+  end
+
+  it 'links to csv' do
+    render
+    reports.each do |report|
+      expect(rendered).to include "#{report.id}_csv_link"
+    end
+  end
+
+  it 'links to counts csv' do
+    render
+    reports.each do |report|
+      expect(rendered).to include "#{report.id}_count_csv_link"
+    end
+  end
+end

data/spec/views/krikri/qa_reports/show.html.erb_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe 'krikri/qa_reports/show.html.erb', type: :view do
+  let(:report) { build(:krikri_qa_report) }
+end

data/spec/views/krikri/records/index.html.erb_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe 'krikri/records/index.html.erb', type: :view do
+  # @todo: test blacklight catalog controller view
+end

data/spec/views/krikri/records/show.html.erb_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe 'krikri/records/show.html.erb', type: :view do
+
+  before do
+    assign(:provider_id, provider.id)
+    assign(:document, document)
+
+    allow(document).to receive(:id).and_return(document_id)
+    allow(view).to receive(:render_enriched_record).with(document)
+                    .and_return(enriched_record)
+    allow(view).to receive(:render_original_record).with(document)
+                    .and_return(original_record)
+
+    # this is a very weak test setup
+    allow(view).to receive(:provider_name).with(provider.id)
+    allow(view).to receive(:random_record_id).with(provider.id)
+                    .and_return('moomin')
+    allow(view).to receive(:link_to).and_return(random_record)
+  end
+
+  let(:provider) { build(:krikri_provider) }
+  let(:document) { double('Blacklight Document') }
+  let(:document_id) { 'moomin' }
+  let(:enriched_record) { 'Enriched Record' }
+  let(:original_record) { 'Original Record' }
+  let(:random_record) { 'RANDOM RECORD LINK' }
+
+  it 'shows document id' do
+    render
+    expect(rendered).to include document_id.html_safe
+  end
+
+  # this is a very weak test
+  it 'links to random record from this provider' do
+    render
+    expect(rendered).to include random_record
+  end
+
+  it 'renders enriched record' do
+    render
+    expect(rendered).to include enriched_record
+  end
+
+  it 'renders original record' do
+    render
+    expect(rendered).to include original_record
+  end
+end

data/spec/views/krikri/reports/index.html.erb_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'krikri/reports/index.html.erb', type: :view do
+  before do
+    assign(:current_provider, provider)
+    assign(:validation_reports, [])
+    assign(:qa_reports, [])
+  end
+
+  let(:provider) { build(:krikri_provider) }
+
+  it 'displays provider name' do
+    render
+    expect(rendered).to include provider.label.first
+  end
+
+  it 'renders validation reports' do
+    render
+    expect(rendered).to include 'Validation Reports'
+  end
+
+  it 'renders qa reports' do
+    render
+    expect(rendered).to include 'QA Reports'
+  end
+end