mods_display 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f646ef8067a80ee0b0318f9f8c8d03ca5450c522772d5f514776aee4f03dae64
-  data.tar.gz: a04eb7333f672aba00e2a6cb0883ff580a027d23c97363becb11a634cf6b1661
+  metadata.gz: 3ac207676bdeba25c5fe05931498d9404d37d3417f2eac034f0dba58f4bbabbd
+  data.tar.gz: 8a1de09dadf358278f6268a41a1e858957c45acdf9fdd5acd5c5c825a391c710
 SHA512:
-  metadata.gz: e5a0a38fac8e49e2e9fdc17c4560fd5cb0461f4c459eddf2981cfccc3e3a7df1cd1477acc9fae4537daf1cb269f439d5809799e09cc9487c8f813529612dbf1a
-  data.tar.gz: '09364c514c07be1ad564fb4f4325a7ad9f9abf031c08f140a7150119c6b2be6e14a8dd06a75e5aa19e3a31f096939df7ce4b87e493e5abbf7e4bdaadfd33daf8'
+  metadata.gz: 84317fe034efa431a52105abd35529992a657e331b8f42f4571b8fc0369c82297a87b7dbb6c0156cd16e4708aa3232c133106f66f55563898a300faf6f10e6a2
+  data.tar.gz: 22f10cbd6bca1feb6796a7a3b2be2e7620f6b25ea285395f075446a8571c1b32f53e9c3f58310b8ac48812d4c31eef72344332950b86ece74cc56f86d395577b

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.6, 2.7]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/lib/mods_display.rb

@@ -49,3 +49,14 @@ require 'i18n/backend/fallbacks'
 I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
 I18n.load_path += Dir["#{File.expand_path('../..', __FILE__)}/config/locales/*.yml"]
 I18n.backend.load_translations
+
+# load Rails/Railtie
+begin
+  require 'rails'
+rescue LoadError
+  #do nothing
+end
+
+if defined? ::Rails::Railtie
+  require 'mods_display/railtie'
+end

data/lib/mods_display/helpers/record_helper.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  module Helpers
+    module RecordHelper
+      def display_content_field(field)
+        return unless field.respond_to?(:label, :values) && field.values.any?(&:present?)
+
+        display_content_label(field.label) + display_content_values(field.values)
+      end
+
+      def display_content_label(label)
+        content_tag :dt, label
+      end
+
+      def display_content_values(values)
+        values.map do |value|
+          content_tag :dd, value
+        end.join('').html_safe
+      end
+
+      def mods_display_label(label)
+        content_tag(:dt, label.delete(':')) + "\n".html_safe
+      end
+
+      def mods_display_content(values, delimiter = nil)
+        if delimiter
+          content_tag(:dd, values.map do |value|
+            link_urls_and_email(value) if value.present?
+          end.compact.join(delimiter).html_safe)
+        else
+          Array[values].flatten.map do |value|
+            content_tag(:dd, link_urls_and_email(value.to_s).html_safe) if value.present?
+          end.join.html_safe
+        end
+      end
+
+      def mods_record_field(field, delimiter = nil)
+        return unless field.respond_to?(:label, :values) && field.values.any?(&:present?)
+
+        mods_display_label(field.label) + mods_display_content(field.values, delimiter)
+      end
+
+      def mods_name_field(field, &block)
+        return unless field.respond_to?(:label, :values) && field.values.any?(&:present?)
+
+        mods_display_label(field.label) + mods_display_name(field.values, &block)
+      end
+
+      def mods_display_name(names, &block)
+        names.map do |name|
+          content_tag(:dd) do
+            block_given? ? yield(name.name) : name.name
+          end
+        end.join.html_safe
+      end
+
+      # We need this to remove the ending ":" from the role labels only in data from
+      # mods_display
+      def sanitize_mods_name_label(label)
+        label.sub(/:$/, '')
+      end
+
+      def mods_subject_field(subject, &block)
+        return unless subject.values.any?(&:present?)
+
+        fields = subject.values.map do |subject_line|
+          content_tag :dd, safe_join(link_mods_subjects(subject_line, &block), ' > ')
+        end
+
+        (mods_display_label(subject.label) + safe_join(fields))
+      end
+
+      def mods_genre_field(genre, &block)
+        return unless genre.values.any?(&:present?)
+
+        fields = genre.values.map do |genre_line|
+          content_tag :dd, link_mods_genres(genre_line, &block)
+        end
+
+        mods_display_label(genre.label) + safe_join(fields)
+      end
+
+      def link_mods_genres(genre, &block)
+        link_buffer = []
+        link_to_mods_subject(genre, link_buffer, &block)
+      end
+
+      def link_mods_subjects(subjects, &block)
+        link_buffer = []
+        linked_subjects = []
+        subjects.each do |subject|
+          if subject.present?
+            linked_subjects << link_to_mods_subject(subject, link_buffer, &block)
+          end
+        end
+        linked_subjects
+      end
+
+      def link_to_mods_subject(subject, buffer, &block)
+        subject_text = subject.respond_to?(:name) ? subject.name : subject
+        link = block_given? ? yield(subject_text, buffer) : subject_text
+        buffer << subject_text.strip
+        link << " (#{subject.roles.join(', ')})" if subject.respond_to?(:roles) && subject.roles.present?
+        link
+      end
+
+      # rubocop:disable Layout/LineLength
+      def link_urls_and_email(val)
+        val = val.dup
+        # http://daringfireball.net/2010/07/improved_regex_for_matching_urls
+        url = %r{(?i)\b(?:https?://|www\d{0,3}[.]|[a-z0-9.\-]+[.][a-z]{2,4}/)(?:[^\s()<>]+|\([^\s()<>]+|\([^\s()<>]+\)*\))+(?:\([^\s()<>]+|\([^\s()<>]+\)*\)|[^\s`!()\[\]{};:'".,<>?«»“”‘’])}i
+        # http://www.regular-expressions.info/email.html
+        email = %r{[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+(?:[A-Z]{2}|com|org|net|edu|gov|mil|biz|info|mobi|name|aero|asia|jobs|museum)\b}i
+        matches = [val.scan(url), val.scan(email)].flatten.uniq
+        unless val =~ /<a/ # we'll assume that linking has alraedy occured and we don't want to double link
+          matches.each do |match|
+            if match =~ email
+              val.gsub!(match, "<a href='mailto:#{match}'>#{match}</a>")
+            else
+              val.gsub!(match, "<a href='#{match}'>#{match}</a>")
+            end
+          end
+        end
+        val
+      end
+      # rubocop:enable Layout/LineLength
+
+    end
+  end
+end

data/lib/mods_display/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ModsDisplay
+  class Railtie < ::Rails::Railtie
+    ActiveSupport.on_load :action_view do
+      require 'mods_display/helpers/record_helper'
+      ::ActionView::Base.send :include, ModsDisplay::Helpers::RecordHelper
+    end
+  end
+end

data/lib/mods_display/version.rb

@@ -1,3 +1,3 @@
 module ModsDisplay
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 end

data/mods_display.gemspec

@@ -22,7 +22,9 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rspec-rails'
   gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'capybara'
   gem.add_development_dependency 'byebug'
+  gem.add_development_dependency 'rails', '~> 6.0'
 end

data/spec/fake_app.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+class ModsDisplayTestApp < Rails::Application
+end
+
+Rails.application.routes.draw do
+  resources 'searches', only: :index
+end
+
+class ApplicationController < ActionController::Base; end
+class SearchesController < ApplicationController
+  def index; end
+end
+
+Object.const_set(:ApplicationHelper, Module.new)

data/spec/helpers/record_helper_spec.rb

@@ -0,0 +1,241 @@
+# 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/spec_helper.rb

@@ -1,6 +1,11 @@
+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.
@@ -24,6 +29,7 @@ RSpec.configure do |config|
   # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mods_display
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Jessie Keck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stanford-mods
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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
@@ -108,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 description: MODS Display is a gem to centralize the display logic of MODS medadata.
 email:
 - jessie.keck@gmail.com
@@ -115,10 +143,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -163,14 +191,17 @@ files:
 - lib/mods_display/fields/subject.rb
 - lib/mods_display/fields/title.rb
 - lib/mods_display/fields/values.rb
+- lib/mods_display/helpers/record_helper.rb
 - lib/mods_display/html.rb
 - lib/mods_display/model_extension.rb
+- lib/mods_display/railtie.rb
 - lib/mods_display/related_item_concerns.rb
 - lib/mods_display/relator_codes.rb
 - lib/mods_display/version.rb
 - mods_display.gemspec
 - spec/configuration/access_condition_spec.rb
 - spec/configuration/base_spec.rb
+- spec/fake_app.rb
 - spec/fields/abstract_spec.rb
 - spec/fields/access_condition_spec.rb
 - spec/fields/audience_spec.rb
@@ -203,6 +234,7 @@ files:
 - spec/fixtures/related_item_fixtures.rb
 - spec/fixtures/subjects_fixtures.rb
 - spec/fixtures/title_fixtures.rb
+- spec/helpers/record_helper_spec.rb
 - spec/integration/configuration_spec.rb
 - spec/integration/html_spec.rb
 - spec/integration/installation_spec.rb
@@ -226,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: The MODS Display gem allows implementers to configure a customized display
@@ -235,6 +267,7 @@ summary: The MODS Display gem allows implementers to configure a customized disp
 test_files:
 - spec/configuration/access_condition_spec.rb
 - spec/configuration/base_spec.rb
+- spec/fake_app.rb
 - spec/fields/abstract_spec.rb
 - spec/fields/access_condition_spec.rb
 - spec/fields/audience_spec.rb
@@ -267,6 +300,7 @@ test_files:
 - spec/fixtures/related_item_fixtures.rb
 - spec/fixtures/subjects_fixtures.rb
 - spec/fixtures/title_fixtures.rb
+- spec/helpers/record_helper_spec.rb
 - spec/integration/configuration_spec.rb
 - spec/integration/html_spec.rb
 - spec/integration/installation_spec.rb

data/.travis.yml

@@ -1,4 +0,0 @@
-notifications:
-  email: false
-rvm:
-  - 2.5.3