newspaper_works 0.1.0

data/spec/model_shared.rb

@@ -0,0 +1,134 @@
+# Shared Model
+RSpec.shared_examples 'a persistent work type' do
+  let(:work) { described_class.new }
+  let(:cls) { described_class }
+
+  describe 'class membership' do
+    it 'has correct instance type' do
+      expect(work).to be_an_instance_of(cls)
+    end
+
+    it 'initially has nil id' do
+      expect(work.id).to be_nil
+    end
+  end
+
+  describe 'object persistence' do
+    before do
+      work.title = ['San Diego Evening Tribune']
+      work.save!
+    end
+
+    it 'has non-nil id after save' do
+      expect(work.id).not_to be_nil
+    end
+
+    it 'appears to be persisted in fcrepo' do
+      expect(cls.all.map(&:id)).to include(work.id)
+    end
+
+    describe 'deletion' do
+      it 'deletes via delete' do
+        work.delete
+        expect(cls.all.map(&:id)).not_to include(work.id)
+      end
+    end
+  end
+end
+
+RSpec.shared_examples 'a PCDM file set' do
+  let(:work) { described_class.new }
+  let(:cls) { described_class }
+
+  it 'looks like a fileset by method introspection' do
+    expect(work.file_set?).to be true
+  end
+
+  it 'does not look like a work' do
+    expect(work.work?).to be false
+  end
+
+  it 'still looks like a PCDM object, though' do
+    expect(work.pcdm_object?).to be true
+  end
+end
+
+RSpec.shared_examples 'a work and PCDM object' do
+  let(:work) { described_class.new }
+  let(:cls) { described_class }
+
+  it 'looks like a work' do
+    expect(work.work?).to be true
+  end
+
+  it 'also looks like a PCDM object' do
+    expect(work.pcdm_object?).to be true
+  end
+
+  it 'does not look like a fileset' do
+    expect(work.file_set?).to be false
+  end
+end
+
+def model_fixtures(target_type)
+  # set up graph of related objects, setting membership on aggregating
+  # parents via members setter method, per PCDM Profile for Newspapers.
+  publication = NewspaperTitle.new
+  publication.title = ["Yesterday's News"]
+  publication.lccn = 'sn1234567'
+  issue1 = NewspaperIssue.new
+  issue1.title = ['December 7, 1941']
+  issue1.publication_date = '1941-12-07'
+  issue1.resource_type = ["newspaper"]
+  issue1.language = ["eng"]
+  issue1.held_by = "Marriott Library"
+  # issue1.save
+  publication.members.push issue1
+  page1 = NewspaperPage.new
+  page1.title = ['Page 1']
+  page1.page_number = '1'
+  page1.height = "200"
+  page1.width = "200"
+  page2 = NewspaperPage.new
+  page2.title = ['Page 2']
+  page2.page_number = '2'
+  page2.height = "200"
+  page2.width = "200"
+  issue1.ordered_members << page1
+  issue1.ordered_members << page2
+  article1 = NewspaperArticle.new
+  article1.title = ['Happening now']
+  article2 = NewspaperArticle.new
+  article2.title = ['Yesterday Summary']
+  # issue aggregates articles
+  issue1.members.push(article1, article2)
+  # article has pages associated, article aggregates pages:
+  article1.members.push(page1)
+  # presume article 2 has a jump
+  article2.members.push(page1, page2)
+  # container for title, has a page
+  container = NewspaperContainer.new
+  container.title = ['Reel123a']
+  publication.members.push(container)
+  container.members.push(page1, page2)
+
+  # save swarm, persist all the things!
+  issue1.save!
+  container.save!
+  publication.save!
+  page1.save!
+  page2.save!
+  article1.save!
+  article2.save!
+
+  # return types appropriate to target class: return correct starting point
+  # for the object graph of these fixtures, in the context of their use.
+  return publication if target_type == NewspaperTitle
+  return issue1 if target_type == NewspaperIssue
+  return page1 if target_type == NewspaperPage
+  return article2 if target_type == NewspaperArticle
+  return container if target_type == NewspaperContainer
+
+  # return multiple objects as needed for testing
+  return [page1, page2] if target_type == :newspaper_pages
+end

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

@@ -0,0 +1,45 @@
+require 'spec_helper'
+RSpec.describe NewspaperWorks::BlacklightIiifSearch::AnnotationBehavior do
+  let(:page_document) { build(:newspaper_page_solr_document) }
+  let(:controller) { CatalogController.new }
+  let(:coordinates) do
+    JSON.parse("{\"coords\":{\"software\":[[2641,4102,512,44]]}}")
+  end
+  let(:parent_document) do
+    SolrDocument.new('id' => page_document[:issue_id_ssi],
+                     'has_model_ssim' => ['NewspaperIssue'])
+  end
+  let(:iiif_search_annotation) do
+    BlacklightIiifSearch::IiifSearchAnnotation.new(page_document, 'software',
+                                                   0, nil, controller,
+                                                   parent_document)
+  end
+  let(:test_request) { ActionDispatch::TestRequest.new({}) }
+
+  before { allow(controller).to receive(:request).and_return(test_request) }
+
+  describe '#annotation_id' do
+    subject { iiif_search_annotation.annotation_id }
+    it 'returns a properly formatted URL' do
+      expect(subject).to include("#{page_document[:issue_id_ssi]}/manifest/canvas/#{page_document[:file_set_ids_ssim].first}/annotation/0")
+    end
+  end
+
+  describe '#canvas_uri_for_annotation' do
+    before { allow(iiif_search_annotation).to receive(:fetch_and_parse_coords).and_return(coordinates) }
+
+    subject { iiif_search_annotation.canvas_uri_for_annotation }
+    it 'returns a properly formatted URL' do
+      expect(subject).to include("#{page_document[:issue_id_ssi]}/manifest/canvas/#{page_document[:file_set_ids_ssim].first}")
+    end
+
+    describe 'private methods' do
+      # test #coordinates based on output of #canvas_uri_for_annotation, which calls it
+      describe '#coordinates' do
+        it 'gets the expected value from #coordinates' do
+          expect(subject).to include("#xywh=2641,4102,512,44")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe NewspaperWorks::BlacklightIiifSearch::SearchBehavior do
+  let(:parent_id) { 'abc123' }
+  let(:search_params) do
+    { q: 'foo', solr_document_id: parent_id }
+  end
+  let(:controller) { CatalogController.new }
+  let(:blacklight_config) { controller.blacklight_config }
+  let(:parent_document) do
+    SolrDocument.new('id' => parent_id,
+                     'has_model_ssim' => ['NewspaperIssue'])
+  end
+  let(:iiif_search) do
+    BlacklightIiifSearch::IiifSearch.new(search_params,
+                                         blacklight_config.iiif_search,
+                                         parent_document)
+  end
+
+  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).to include('issue_id_ssi')
+      expect(subject.values).to include(parent_id)
+    end
+  end
+end

data/spec/models/concerns/newspaper_works/newspaper_core_metadata_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+# Core Metadata Spec Tests
+RSpec.describe NewspaperWorks::NewspaperCoreMetadata do
+  class NewspaperishWork < ActiveFedora::Base
+    include ::Hyrax::WorkBehavior
+    include NewspaperWorks::NewspaperCoreMetadata
+    include ::Hyrax::BasicMetadata
+  end
+
+  let(:work) { NewspaperishWork.new }
+
+  it 'creates work using mixin' do
+    expect(work).to be_an_instance_of(NewspaperishWork)
+  end
+
+  it 'has expected properties' do
+    expect(work).to respond_to(:alternative_title)
+    expect(work).to respond_to(:place_of_publication)
+    expect(work).to respond_to(:issn)
+    expect(work).to respond_to(:lccn)
+    expect(work).to respond_to(:oclcnum)
+    expect(work).to respond_to(:held_by)
+  end
+
+  it 'uses correct class for place_of_publication' do
+    pop_class = work.class.properties['place_of_publication'].class_name
+    expect(pop_class).to eq Hyrax::ControlledVocabularies::Location
+  end
+
+  it 'work can set/get properties' do
+    issn_value = '0000-1111'
+    work.issn = issn_value
+    expect(work.issn).to eq issn_value
+  end
+
+  it 'work using mixin saves' do
+    work.place_of_publication = ['http://www.geonames.org/5780993/about.rdf']
+    work.alternative_title = ['The alt title']
+    expect(work.id).to be_nil
+    work.save!
+    expect(work.id).not_to be_nil
+    expect(NewspaperishWork.all.map(&:id)).to include(work.id)
+  end
+end

data/spec/models/concerns/newspaper_works/place_of_publication_behavior_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+# Core Metadata Spec Tests
+RSpec.describe NewspaperWorks::PlaceOfPublicationBehavior do
+  class NewspaperishWork < ActiveFedora::Base
+    include ::Hyrax::WorkBehavior
+    include NewspaperWorks::NewspaperCoreMetadata
+    include ::Hyrax::BasicMetadata
+    include NewspaperWorks::PlaceOfPublicationBehavior
+  end
+
+  let(:work) { NewspaperishWork.new }
+
+  it 'has controlled properties' do
+    expect(work.controlled_properties).to eq([:place_of_publication])
+  end
+end

data/spec/models/concerns/newspaper_works/scanned_media_metadata_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+# Scanned Media Metadata Spec Tests
+RSpec.describe NewspaperWorks::ScannedMediaMetadata do
+  class ScannedMediaWork < ActiveFedora::Base
+    include ::Hyrax::WorkBehavior
+    include NewspaperWorks::ScannedMediaMetadata
+    include ::Hyrax::BasicMetadata
+  end
+
+  let(:work) { ScannedMediaWork.new }
+
+  it 'creates work using mixin' do
+    expect(work).to be_an_instance_of(ScannedMediaWork)
+  end
+
+  it 'has expected properties' do
+    expect(work).to respond_to(:text_direction)
+    expect(work).to respond_to(:page_number)
+    expect(work).to respond_to(:section)
+  end
+
+  it 'work can set/get properties' do
+    work.section = 'foo'
+    expect(work.section).to include 'foo'
+  end
+
+  it 'work using mixin saves' do
+    work.title = ['label able label']
+    expect(work.id).to be_nil
+    work.save!
+    expect(work.id).not_to be_nil
+    expect(ScannedMediaWork.all.map(&:id)).to include(work.id)
+  end
+end

data/spec/models/newspaper_article_spec.rb

@@ -0,0 +1,73 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperArticle`
+require 'spec_helper'
+require 'model_shared'
+
+RSpec.describe NewspaperArticle do
+  before(:all) do
+    @fixture = model_fixtures(described_class)
+  end
+
+  # shared behaviors
+  it_behaves_like('a work and PCDM object')
+  it_behaves_like('a persistent work type')
+
+  describe 'Metadata properties' do
+    it 'has expected properties' do
+      expect(@fixture).to respond_to(:author)
+      expect(@fixture).to respond_to(:photographer)
+      expect(@fixture).to respond_to(:genre)
+      expect(@fixture).to respond_to(:volume)
+      expect(@fixture).to respond_to(:edition_number)
+      expect(@fixture).to respond_to(:edition_name)
+      expect(@fixture).to respond_to(:issue_number)
+      expect(@fixture).to respond_to(:geographic_coverage)
+      expect(@fixture).to respond_to(:extent)
+      expect(@fixture).to respond_to(:publication_date)
+    end
+  end
+
+  describe 'Relationship methods' do
+    it 'has expected test fixture' do
+      expect(@fixture).to be_an_instance_of(described_class)
+    end
+
+    it 'can get aggregated pages' do
+      pages = @fixture.pages
+      expect(pages).to be_an_instance_of(Array)
+      expect(pages.length).to be > 0
+      pages.each do |e|
+        expect(e).to be_an_instance_of(NewspaperPage)
+      end
+    end
+
+    it 'can get aggregating issue' do
+      issue = @fixture.issue
+      expect(issue).to be_an_instance_of(NewspaperIssue)
+    end
+
+    it 'can get publication (transitive)' do
+      publication = @fixture.publication
+      expect(publication).to be_an_instance_of(NewspaperTitle)
+    end
+
+    it 'can get aggregating container (transitive)' do
+      container = @fixture.container
+      expect(container).to be_an_instance_of(NewspaperContainer)
+    end
+  end
+
+  describe 'publication_date' do
+    it "is not valid with bad date format" do
+      na = described_class.new(title: ["Breaking News!"],
+                               publication_date: "06/21/1978")
+      expect(na).not_to be_valid
+    end
+
+    it "is valid with proper date format" do
+      na = described_class.new(title: ["Breaking News!"],
+                               publication_date: "1978-06-21")
+      expect(na).to be_valid
+    end
+  end
+end

data/spec/models/newspaper_container_spec.rb

@@ -0,0 +1,111 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperContainer`
+require 'spec_helper'
+require 'model_shared'
+
+RSpec.describe NewspaperContainer do
+  before(:all) do
+    @fixture = model_fixtures(described_class)
+  end
+
+  # shared behaviors
+  it_behaves_like('a work and PCDM object')
+  it_behaves_like('a persistent work type')
+
+  describe "Metadata properties" do
+    it "has expected properties" do
+      expect(@fixture).to respond_to(:extent)
+      expect(@fixture).to respond_to(:publication_date_start)
+      expect(@fixture).to respond_to(:publication_date_end)
+    end
+  end
+
+  describe "Relationship methods" do
+    it "has expected test fixture" do
+      expect(@fixture).to be_an_instance_of(described_class)
+    end
+
+    it "can get aggregating publication/title" do
+      parent = @fixture.publication
+      expect(parent).not_to be_nil
+      expect(parent).to be_an_instance_of(NewspaperTitle)
+      # reciprocity and round-trip
+      expect(parent.containers).to include @fixture
+    end
+
+    it "can get aggregated pages" do
+      contained_pages = @fixture.pages
+      expect(contained_pages).to be_an_instance_of(Array)
+      expect(contained_pages.length).to be > 0
+      contained_pages.each do |e|
+        expect(e).to be_an_instance_of(NewspaperPage)
+      end
+    end
+  end
+
+  describe 'publication_date_start' do
+    it "is not valid with bad date format" do
+      nc = described_class.new(title: ["Breaking News!"],
+                               publication_date_start: "06/21/1978")
+      expect(nc).not_to be_valid
+    end
+
+    it "is valid with proper date format" do
+      nc = described_class.new(title: ["Breaking News!"],
+                               publication_date_start: "1978-06-21")
+      expect(nc).to be_valid
+    end
+
+    it "is valid with a year" do
+      nc = described_class.new(title: ["Breaking News!"],
+                               publication_date_start: "1978")
+      expect(nc).to be_valid
+    end
+
+    it "is valid with a year and month" do
+      nc = described_class.new(title: ["Breaking News!"],
+                               publication_date_start: "1978-06")
+      expect(nc).to be_valid
+    end
+
+    it "is not valid with start date after end date" do
+      nc = described_class.new(title: ["Breaking News!"],
+                               publication_date_start: "1978-06-01",
+                               publication_date_end: "1977-06-01")
+      expect(nc).not_to be_valid
+    end
+
+    it "is valid with start date before end date" do
+      nc = described_class.new(title: ["Breaking News!"],
+                               publication_date_start: "1978-06-01",
+                               publication_date_end: "1979-06-01")
+      expect(nc).to be_valid
+    end
+  end
+
+  describe 'publication_date_end' do
+    it "is not valid with bad date format" do
+      nc = described_class.new(title: ["Breaking News!"],
+                               publication_date_end: "06/21/1978")
+      expect(nc).not_to be_valid
+    end
+
+    it "is valid with proper date format" do
+      nc = described_class.new(title: ["Breaking News!"],
+                               publication_date_end: "1978-06-21")
+      expect(nc).to be_valid
+    end
+
+    it "is valid with a year" do
+      nc = described_class.new(title: ["Breaking News!"],
+                               publication_date_end: "1978")
+      expect(nc).to be_valid
+    end
+
+    it "is valid with a year and month" do
+      nc = described_class.new(title: ["Breaking News!"],
+                               publication_date_end: "1978-06")
+      expect(nc).to be_valid
+    end
+  end
+end

data/spec/models/newspaper_issue_spec.rb

@@ -0,0 +1,91 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperIssue`
+require 'spec_helper'
+require 'model_shared'
+
+RSpec.describe NewspaperIssue do
+  before(:all) do
+    @fixture = model_fixtures(described_class)
+  end
+
+  # shared behaviors
+  it_behaves_like('a work and PCDM object')
+  it_behaves_like('a persistent work type')
+
+  describe 'Metadata properties' do
+    it 'has expected properties' do
+      expect(@fixture).to respond_to(:volume)
+      expect(@fixture).to respond_to(:edition_number)
+      expect(@fixture).to respond_to(:edition_name)
+      expect(@fixture).to respond_to(:issue_number)
+      expect(@fixture).to respond_to(:extent)
+      expect(@fixture).to respond_to(:publication_date)
+    end
+  end
+
+  describe 'Relationship methods' do
+    it 'has expected test fixture' do
+      expect(@fixture).to be_an_instance_of(described_class)
+    end
+
+    it 'can get aggregating publication/title' do
+      parent = @fixture.publication
+      expect(parent).not_to be_nil
+      expect(parent).to be_an_instance_of(NewspaperTitle)
+      # reciprocity and round-trip
+      expect(parent.issues).to include @fixture
+    end
+
+    it 'can get aggregated pages' do
+      contained_pages = @fixture.pages
+      expect(contained_pages).to be_an_instance_of(Array)
+      expect(contained_pages.length).to be > 0
+      contained_pages.each do |e|
+        expect(e).to be_an_instance_of(NewspaperPage)
+      end
+    end
+
+    it 'can get ordered pages' do
+      ordered_pages = @fixture.ordered_pages
+      expect(ordered_pages).to be_an_instance_of(Array)
+      expect(ordered_pages.length).to be > 0
+      ordered_pages.each do |e|
+        expect(e).to be_an_instance_of(NewspaperPage)
+      end
+      # same constituent pages as members:
+      expect(@fixture.pages.to_a).to match_array ordered_pages
+    end
+
+    it 'can get ordered page ids' do
+      ordered_page_ids = @fixture.ordered_page_ids
+      expect(ordered_page_ids).to be_an_instance_of(Array)
+      expect(ordered_page_ids.length).to be > 0
+      ordered_page_ids.each do |e|
+        expect(e).to be_an_instance_of(String)
+      end
+    end
+
+    it 'can get aggregated articles' do
+      contained_articles = @fixture.articles
+      expect(contained_articles).to be_an_instance_of(Array)
+      expect(contained_articles.length).to be > 0
+      contained_articles.each do |e|
+        expect(e).to be_an_instance_of(NewspaperArticle)
+      end
+    end
+  end
+
+  describe 'publication_date' do
+    it "is not valid with bad date format" do
+      ni = described_class.new(title: ["Breaking News!"],
+                               publication_date: "06/21/1978")
+      expect(ni).not_to be_valid
+    end
+
+    it "is valid with proper date format" do
+      ni = described_class.new(title: ["Breaking News!"],
+                               publication_date: "1978-06-21")
+      expect(ni).to be_valid
+    end
+  end
+end

data/spec/models/newspaper_page_spec.rb

@@ -0,0 +1,44 @@
+# Generated via
+#  `rails generate hyrax:work NewspaperPage`
+require 'spec_helper'
+require 'model_shared'
+
+RSpec.describe NewspaperPage do
+  before(:all) do
+    @fixture = model_fixtures(described_class)
+  end
+
+  it_behaves_like('a work and PCDM object')
+  it_behaves_like('a persistent work type')
+
+  describe 'Relationship methods' do
+    it 'has expected test fixture' do
+      expect(@fixture).to be_an_instance_of(described_class)
+    end
+
+    it 'can get aggregating articles for page' do
+      articles = @fixture.articles
+      expect(articles).to be_an_instance_of(Array)
+      expect(articles.length).to be > 0
+      articles.each do |e|
+        expect(e).to be_an_instance_of(NewspaperArticle)
+      end
+    end
+
+    it 'can get aggregating issue for page' do
+      issue = @fixture.issue
+      expect(issue).to be_an_instance_of(NewspaperIssue)
+    end
+
+    it 'can get aggregating container for page' do
+      container = @fixture.container
+      expect(container).to be_an_instance_of(NewspaperContainer)
+    end
+
+    it 'can get publication (transitive)' do
+      publication = @fixture.publication
+      expect(publication).not_to be_nil
+      expect(publication).to be_an_instance_of(NewspaperTitle)
+    end
+  end
+end