mods_display 0.10.1 → 1.0.0.alpha1

data/spec/fixtures/title_fixtures.rb

@@ -1,115 +0,0 @@
-module TitleFixtures
-  def simple_title_fixture
-    <<-XML
-      <mods>
-        <titleInfo><title>Title</title></titleInfo>
-      </mods>
-    XML
-  end
-
-  def title_parts_fixture
-    <<-XML
-      <mods>
-        <titleInfo>
-          <nonSort>The</nonSort>
-          <title>Title</title>
-          <subTitle>For</subTitle>
-          <partName>Something</partName>
-          <partNumber>Part 62</partNumber>
-        </titleInfo>
-      </mods>
-    XML
-  end
-
-  def reverse_title_parts_fixture
-    <<-XML
-      <mods>
-        <titleInfo>
-          <nonSort>The</nonSort>
-          <title>Title : </title>
-          <subTitle>For</subTitle>
-          <partNumber>Part 62</partNumber>
-          <partName>Something</partName>
-        </titleInfo>
-      </mods>
-    XML
-  end
-
-  def display_label_fixture
-    <<-XML
-      <mods>
-        <titleInfo displayLabel='MyTitle'>
-          <title>Title</title>
-        </titleInfo>
-      </mods>
-    XML
-  end
-
-  def display_form_fixture
-    <<-XML
-      <mods>
-        <titleInfo>
-          <title>Title</title>
-          <displayForm>The Title of This Item</displayForm>
-        </titleInfo>
-      </mods>
-    XML
-  end
-
-  def multi_label_fixture
-    <<-XML
-      <mods>
-        <titleInfo>
-          <title>Main Title</title>
-        </titleInfo>
-        <titleInfo type='alternative'>
-          <title>Alt Title</title>
-        </titleInfo>
-        <titleInfo type='uniform'>
-          <title>Uniform Title</title>
-        </titleInfo>
-        <titleInfo type='alternative'>
-          <title>Another Alt Title</title>
-        </titleInfo>
-        <titleInfo type='alternative'>
-          <title>Yet Another Alt Title</title>
-        </titleInfo>
-      </mods>
-    XML
-  end
-
-  def alt_title_fixture
-    <<-XML
-      <mods>
-        <titleInfo type='alternative'>
-          <title>Title</title>
-        </titleInfo>
-      </mods>
-    XML
-  end
-
-  def title_puncutation_fixture
-    <<-XML
-      <mods>
-        <titleInfo>
-          <title>A title that ends in punctuation.</title>
-          <partNumber>2015</partNumber>
-        </titleInfo>
-      </mods>
-    XML
-  end
-
-  def ordered_title_fixture
-    <<-XML
-    <mods>
-      <titleInfo>
-        <nonSort>The</nonSort>
-        <title>medium term expenditure framework (MTEF) for ... and the annual estimates for ...</title>
-        <partNumber>016</partNumber>
-        <partName>Ministry of Tourism</partName>
-        <subTitle>expenditure to be met out of moneys granted and drawn from the consolidated fund, central government budget</subTitle>
-      </titleInfo>
-    </mods>
-    XML
-  end
-end

data/spec/helpers/record_helper_spec.rb

@@ -1,241 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'byebug'
-
-describe ModsDisplay::Helpers::RecordHelper, type: :helper do
-  let(:empty_field) { OpenStruct.new(label: 'test', values: ['']) }
-
-  describe 'display_content_field' do
-    let(:values) { ['guitar (1)', 'solo cowbell, trombone (2)'] }
-    let(:content) { OpenStruct.new(label: 'Instrumentation', values: values) }
-
-    it 'should return dt with label and dd with values' do
-      expect(helper.display_content_field(content)).to have_css('dt', text: 'Instrumentation')
-      expect(helper.display_content_field(content)).to have_css('dd', count: 2)
-    end
-  end
-
-  describe 'display_content_label' do
-    it 'should return correct dt' do
-      expect(helper.display_content_label('test')).to have_css('dt', text: 'test')
-    end
-  end
-
-  describe 'display_content_values' do
-    let(:values) { ['guitar (1)', 'solo cowbell, trombone (2)'] }
-
-    it 'should return dds of values' do
-      expect(helper.display_content_values(values)).to have_css('dd', count: 2)
-      expect(helper.display_content_values(values)).to have_css('dd', text: 'guitar (1)')
-      expect(helper.display_content_values(values)).to have_css('dd', text: 'solo cowbell, trombone (2)')
-    end
-  end
-
-  describe 'mods_display_label' do
-    it 'should return correct label' do
-      expect(helper.mods_display_label('test:')).not_to have_content ':'
-      expect(helper.mods_display_label('test:')).to have_css('dt', text: 'test')
-    end
-  end
-
-  describe 'mods_display_content' do
-    it 'should return correct content' do
-      expect(helper.mods_display_content('hello, there')).to have_css('dd', text: 'hello, there')
-    end
-    it 'should return multiple dd elements when a multi-element array is passed' do
-      expect(helper.mods_display_content(%w(hello there))).to have_css('dd', count: 2)
-    end
-    it 'should handle nil values correctly' do
-      expect(helper.mods_display_content(['something', nil])).to have_css('dd', count: 1)
-    end
-  end
-
-  describe 'mods_record_field' do
-    let(:mods_field) { OpenStruct.new(label: 'test', values: ['hello, there']) }
-    let(:url_field) { OpenStruct.new(label: 'test', values: ['https://library.stanford.edu']) }
-    let(:multi_values) { double(label: 'test', values: %w(123 321)) }
-
-    it 'should return correct content' do
-      expect(helper.mods_record_field(mods_field)).to have_css('dt', text: 'test')
-      expect(helper.mods_record_field(mods_field)).to have_css('dd', text: 'hello, there')
-    end
-    it 'should link fields with URLs' do
-      expect(mods_record_field(url_field)).to have_css("a[href='https://library.stanford.edu']", text: 'https://library.stanford.edu')
-    end
-    it 'should not print empty labels' do
-      expect(helper.mods_record_field(empty_field)).not_to be_present
-    end
-    it 'should join values with a <dd> by default' do
-      expect(helper.mods_record_field(multi_values)).to have_css('dd', count: 2)
-    end
-    it 'should join values with a supplied delimiter' do
-      expect(helper.mods_record_field(multi_values, 'DELIM')).to have_css('dd', count: 1)
-      expect(helper.mods_record_field(multi_values, 'DELIM')).to have_css('dd', text: '123DELIM321')
-    end
-  end
-
-  describe 'names' do
-    let(:name_field) do
-      OpenStruct.new(
-        label: 'Contributor',
-        values: [
-          OpenStruct.new(name: 'Winefrey, Oprah', roles: %w(Host Producer)),
-          OpenStruct.new(name: 'Kittenz, Emergency')
-        ]
-      )
-    end
-
-    describe '#mods_name_field' do
-      it 'should join the label and values' do
-        name = mods_name_field(name_field) do |name|
-          link_to(name, searches_path(q: "\"#{name}\"", search_field: 'search_author'))
-        end
-        expect(name).to match /<dt>Contributor<\/dt>/
-        expect(name).to match /<dd><a href.*<\/dd>/
-      end
-      it 'should not print empty labels' do
-        expect(mods_name_field(empty_field)).not_to be_present
-      end
-    end
-
-    describe '#mods_display_name' do
-      let(:name) do
-        mods_display_name(name_field.values) do |name|
-          link_to(name, searches_path(q: "\"#{name}\"", search_field: 'search_author'))
-        end
-      end
-
-      it 'should link to the name' do
-        expect(name).to match /<a href=.*%22Winefrey%2C\+Oprah%22.*>Winefrey, Oprah<\/a>/
-        expect(name).to match /<a href=.*%22Kittenz%2C\+Emergency%22.*>Kittenz, Emergency<\/a>/
-      end
-      it 'should link to an author search' do
-        expect(name).to match /<a href.*search_field=search_author.*>/
-      end
-    end
-
-    describe '#sanitize_mods_name_label' do
-      it 'removes a ":" at the end of label if present' do
-        expect(sanitize_mods_name_label('Test String:')).to eq 'Test String'
-        expect(sanitize_mods_name_label('Test String')).to eq 'Test String'
-      end
-    end
-  end
-
-  describe 'subjects' do
-    let(:subjects) { [OpenStruct.new(label: 'Subjects', values: [%w(Subject1a Subject1b), %w(Subject2a Subject2b Subject2c)])] }
-    let(:name_subjects) { [OpenStruct.new(label: 'Subjects', values: [OpenStruct.new(name: 'Person Name', roles: %w(Role1 Role2))])] }
-    let(:genres) { [OpenStruct.new(label: 'Genres', values: %w(Genre1 Genre2 Genre3))] }
-
-    describe '#mods_subject_field' do
-      let(:subject) do
-        mods_subject_field(subjects.first) do |subject_text|
-          link_to(
-            subject_text,
-            searches_path(
-              q: "\"#{[[], subject_text.strip].flatten.join(' ')}\"",
-              search_field: 'subject_terms'
-            )
-          )
-        end
-      end
-      it 'should join the subject fields in a dd' do
-        expect(subject).to match /<dd><a href=*.*\">Subject1a*.*Subject1b<\/a><\/dd><dd><a/
-      end
-      it "should join the individual subjects with a '>'" do
-        expect(subject).to match /Subject2b<\/a> &gt; <a href/
-      end
-      it 'should not print empty labels' do
-        expect(mods_subject_field(empty_field)).not_to be_present
-      end
-    end
-
-    describe '#mods_genre_field' do
-      it 'should join the genre fields with a dd' do
-        expect(mods_genre_field(genres.first) do |text|
-          link_to(text, searches_path(q: text))
-        end).to match /<dd><a href=*.*>Genre1*.*<\/a><\/dd><dd><a*.*Genre2<\/a><\/dd>/
-      end
-      it 'should not print empty labels' do
-        expect(mods_genre_field(empty_field)).not_to be_present
-      end
-    end
-
-    describe '#link_mods_subjects' do
-      let(:linked_subjects) do
-        link_mods_subjects(subjects.first.values.last) do |subject_text, buffer|
-          link_to(
-            subject_text,
-            searches_path(
-              q: "\"#{[buffer, subject_text.strip].flatten.join(' ')}\"",
-              search_field: 'subject_terms'
-            )
-          )
-        end
-      end
-
-      it 'should return all subjects' do
-        expect(linked_subjects.length).to eq 3
-      end
-      it 'should link to the subject hierarchically' do
-        expect(linked_subjects[0]).to match /^<a href=.*q=%22Subject2a%22.*>Subject2a<\/a>$/
-        expect(linked_subjects[1]).to match /^<a href=.*q=%22Subject2a\+Subject2b%22.*>Subject2b<\/a>$/
-        expect(linked_subjects[2]).to match /^<a href=.*q=%22Subject2a\+Subject2b\+Subject2c%22.*>Subject2c<\/a>$/
-      end
-      it 'should link to subject terms search field' do
-        linked_subjects.each do |subject|
-          expect(subject).to match /search_field=subject_terms/
-        end
-      end
-    end
-
-    describe '#link_mods_genres' do
-      let(:linked_genres) do
-        link_mods_genres(genres.first.values.last) do |text|
-          link_to(
-            text,
-            searches_path(
-              q: "\"#{[[], text.strip].flatten.join(' ')}\"",
-              search_field: 'subject_terms'
-            )
-          )
-        end
-      end
-
-      it 'should return correct link' do
-        expect(linked_genres).to match /<a href=*.*Genre3*.*<\/a>/
-      end
-      it 'should link to subject terms search field' do
-        expect(linked_genres).to match /search_field=subject_terms/
-      end
-    end
-
-    describe '#link_to_mods_subject' do
-      it 'should handle subjects that behave like names' do
-        name_subject = link_to_mods_subject(name_subjects.first.values.first, []) do |subject_text|
-          link_to(
-            subject_text,
-            searches_path(
-              q: "\"#{[[], subject_text.strip].flatten.join(' ')}\"",
-              search_field: 'subject_terms'
-            )
-          )
-        end
-        expect(name_subject).to match /<a href=.*%22Person\+Name%22.*>Person Name<\/a> \(Role1, Role2\)/
-      end
-    end
-  end
-
-  describe '#link_urls_and_email' do
-    let(:url) { 'This is a field that contains an https://library.stanford.edu URL' }
-    let(:email) { 'This is a field that contains an email@email.com address' }
-
-    it 'should link URLs' do
-      expect(link_urls_and_email(url)).to eq "This is a field that contains an <a href='https://library.stanford.edu'>https://library.stanford.edu</a> URL"
-    end
-    it 'should link email addresses' do
-      expect(link_urls_and_email(email)).to eq "This is a field that contains an <a href='mailto:email@email.com'>email@email.com</a> address"
-    end
-  end
-end

data/spec/integration/configuration_spec.rb

@@ -1,57 +0,0 @@
-require 'spec_helper'
-
-class TestNoConfigController
-  include ModsDisplay::ControllerExtension
-end
-
-class TestConfigController
-  include ModsDisplay::ControllerExtension
-
-  configure_mods_display do
-    title do
-      label_class 'label-class'
-      value_class 'value-class'
-      link :link_to_title, '%value%'
-    end
-    contact do
-      ignore!
-    end
-  end
-
-  def link_to_title(title)
-    "/path/to/title?#{title}"
-  end
-end
-
-describe 'Configuration' do
-  before(:all) do
-    xml = "<mods>
-      <titleInfo><title>The Title of this Item</title></titleInfo>
-      <note type='contact'>jdoe@example.com</note>
-    </mods>"
-    model = TestModel.new
-    model.modsxml = xml
-    @no_config_controller = TestNoConfigController.new
-    @config_controller = TestConfigController.new
-    @html = @config_controller.render_mods_display(model)
-  end
-  it 'should apply the label class' do
-    expect(@html).to match(/<dt class='label-class' title=/)
-  end
-  it 'should apply the value class' do
-    expect(@html.scan(/<dd class='value-class'>/).length).to eq(1)
-  end
-  it 'should apply the link' do
-    @html.scan(%r{<a href='/path/to/title\?The Title of this Item'>The Title of this Item</a>})
-  end
-  it 'should ignore fields if requested' do
-    expect(@html.scan(/jdoe@example\.com/).length).to eq(0)
-  end
-  it 'should get overriden configurations' do
-    expect(@no_config_controller.mods_display_config.contact.ignore?).to be false
-    expect(@config_controller.mods_display_config.contact.ignore?).to be true
-  end
-  it 'should get default configurations when no controller configuration is supplied' do
-    expect(@no_config_controller.mods_display_config.note.delimiter).to eq('<br/>')
-  end
-end

data/spec/integration/html_spec.rb

@@ -1,87 +0,0 @@
-# encoding: UTF-8
-require 'spec_helper'
-
-def html_from_mods(xml, locale = nil)
-  model = TestModel.new
-  model.modsxml = xml
-  I18n.locale = locale if locale
-  I18n.fallbacks[:fr] = [:fr, :en]
-  TestController.new.render_mods_display(model)
-end
-
-describe 'HTML Output' do
-  before(:all) do
-    @multiple_titles = html_from_mods(
-      <<-MODS
-        <mods>
-          <titleInfo>
-            <title>Main Title</title>
-          </titleInfo>
-          <titleInfo type='alternative'>
-            <title>Alternate Title</title>
-          </titleInfo>
-        </mods>
-      MODS
-    )
-    @abstract = html_from_mods("<mods><abstract>Hey. I'm an abstract.</abstract></mods>")
-    mods = "<mods><titleInfo><title>Main Title</title></titleInfo><abstract>Hey. I'm an abstract.</abstract></mods>"
-    @mods = html_from_mods(mods)
-    @fr_mods = html_from_mods(mods, :fr)
-  end
-  after(:all) do
-    I18n.locale = :en
-  end
-  describe 'i18n' do
-    it 'should get the default english translations' do
-      expect(@mods.to_html).to match(%r{<dt title='Title'>Title:</dt>})
-    end
-    it 'should internationalize the labels when translations are available' do
-      expect(@fr_mods.to_html).to match(%r{<dt title='Résumé'>Résumé :</dt>})
-    end
-    it 'should get fallback to the default english translations if a translation is missing' do
-      expect(@fr_mods.to_html).to match(%r{<dt title='Title'>Title:</dt>})
-    end
-  end
-  describe 'titles' do
-    it 'should include both titles it regular display' do
-      expect(@multiple_titles.to_html).to include('<dd>Main Title</dd>')
-      expect(@multiple_titles.to_html).to include('<dd>Alternate Title</dd>')
-    end
-    it 'should return just the first title in the #title method' do
-      expect(@multiple_titles.title).to eq(['Main Title'])
-    end
-    it 'should omit the first title and return any remaining titles in the #body' do
-      expect(@multiple_titles.body).not_to include('<dd>Main Title</dd>')
-      expect(@multiple_titles.body).to include('<dd>Alternate Title</dd>')
-    end
-
-    it 'should allow access to the subTitle independently from the title (for use with #body or fields)' do
-      sub_title = @multiple_titles.subTitle
-      expect(sub_title.length).to eq 1
-      expect(sub_title.first).to be_a ModsDisplay::Values
-      expect(sub_title.first.label).to match(/^Alternative title/i)
-      expect(sub_title.first.values).to eq(['Alternate Title'])
-    end
-  end
-  describe 'individual fields' do
-    it 'should return ModsDispaly::Values for the specefied field' do
-      fields = @abstract.abstract
-      fields.each do |field|
-        expect(field).to be_a ModsDisplay::Values
-      end
-      expect(fields.length).to eq 1
-      expect(fields.first.values).to eq ["Hey. I'm an abstract."]
-    end
-    it 'should return a blank array if no data is available for a specific field' do
-      expect(@abstract.genre).to eq []
-    end
-    it "should not return a field that doesn't exist (and isn't a string)" do
-      expect { @abstract.not_a_real_field }.to raise_error NoMethodError
-    end
-  end
-  describe 'individual fields' do
-    it 'should return ModsDispaly::Class when raw is specified' do
-      expect(@abstract.abstract(raw: true)).to be_a ModsDisplay::Abstract
-    end
-  end
-end

data/spec/integration/installation_spec.rb

@@ -1,26 +0,0 @@
-require 'spec_helper'
-
-describe 'Installation' do
-  before(:all) do
-    @pieces_of_data = 1
-    title_xml = '<mods><titleInfo><title>The Title of this Item</title></titleInfo></mods>'
-    model = TestModel.new
-    model.modsxml = title_xml
-    controller = TestController.new
-    @html = controller.render_mods_display(model)
-  end
-  it 'should return a single <dl>' do
-    expect(@html.scan(/<dl>/).length).to eq(1)
-    expect(@html.scan(%r{</dl>}).length).to eq(1)
-  end
-  it 'should return a dt/dd pair for each piece of metadata in the mods' do
-    expect(@html.scan(/<dt/).length).to eq(@pieces_of_data)
-    expect(@html.scan(/<dd>/).length).to eq(@pieces_of_data)
-  end
-  it 'should return a proper label' do
-    expect(@html.scan(%r{<dt title='Title'>Title:</dt>}).length).to eq(1)
-  end
-  it 'should return a proper value' do
-    expect(@html.scan(%r{<dd>The Title of this Item</dd>}).length).to eq(1)
-  end
-end

data/spec/spec_helper.rb

@@ -1,46 +0,0 @@
-ENV['RAILS_ENV'] ||= 'test'
-require 'mods_display'
-require 'stanford-mods'
-require 'capybara'
-require 'rails'
-require 'fake_app'
-require 'rspec/rails'
-require 'mods_display/helpers/record_helper'
-
-Dir["#{File.expand_path('..', __FILE__)}/fixtures/*.rb"].each { |file| require file }
-# Load i18n test file.
-# We don't have any reliable translations yet so this
-# just make sure that we're handling i18n properly.
-I18n.load_path += Dir["#{File.expand_path('../..', __FILE__)}/spec/test_fr.yml"]
-I18n.backend.load_translations
-
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = 'random'
-  config.include Rails.application.routes.url_helpers
-end
-class TestModel
-  attr_accessor :modsxml
-  include ModsDisplay::ModelExtension
-  mods_xml_source(&:modsxml)
-end
-
-class TestController
-  include ModsDisplay::ControllerExtension
-
-  def link_method(val)
-    "http://library.stanford.edu?#{val}"
-  end
-end

data/spec/test_fr.yml

@@ -1,3 +0,0 @@
-fr:
-  mods_display:
-    abstract: "Résumé :"