mods_display 0.10.1 → 1.0.0.alpha1

data/.github/workflows/ruby.yml

@@ -1,24 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  tests:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby: [2.6, 2.7, 3.0]
-    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/.gitignore

@@ -1,21 +0,0 @@
-*.gem
-*.rbc
-.rvmrc
-.ruby-version
-.ruby-gemset
-.bundle
-.config
-.yardoc
-.rvmrc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/lib/mods_display/configuration/access_condition.rb

@@ -1,21 +0,0 @@
-module ModsDisplay
-  class Configuration
-    class AccessCondition < Base
-      def delimiter(delimiter = '<br/>')
-        @delimiter ||= delimiter
-      end
-
-      def ignore?
-        @ignore.nil? ? true : @ignore
-      end
-
-      def display!
-        @ignore = false
-      end
-
-      def cc_license_version(cc_license_version = '3.0')
-        @cc_license_version ||= cc_license_version
-      end
-    end
-  end
-end

data/lib/mods_display/configuration/base.rb

@@ -1,34 +0,0 @@
-module ModsDisplay
-  class Configuration
-    class Base
-      def initialize(&config)
-        instance_eval(&config) if block_given?
-      end
-
-      def label_class(label_class = '')
-        @label_class ||= label_class
-      end
-
-      def value_class(value_class = '')
-        @value_class ||= value_class
-      end
-
-      def delimiter(delimiter = ', ')
-        @delimiter ||= delimiter
-      end
-
-      def link(method_name = '', args = {})
-        return @link if method_name == ''
-        @link ||= [method_name, args]
-      end
-
-      def ignore!
-        @ignore = true
-      end
-
-      def ignore?
-        @ignore || false
-      end
-    end
-  end
-end

data/lib/mods_display/configuration/genre.rb

@@ -1,9 +0,0 @@
-module ModsDisplay
-  class Configuration
-    class Genre < Base
-      def delimiter(delimiter = '<br/>')
-        @delimiter ||= delimiter
-      end
-    end
-  end
-end

data/lib/mods_display/configuration/imprint.rb

@@ -1,13 +0,0 @@
-module ModsDisplay
-  class Configuration
-    class Imprint < Base
-      def full_date_format(full_date_format = '%B %d, %Y')
-        @full_date_format ||= full_date_format
-      end
-
-      def short_date_format(short_date_format = '%B %Y')
-        @short_date_format ||= short_date_format
-      end
-    end
-  end
-end

data/lib/mods_display/configuration/name.rb

@@ -1,9 +0,0 @@
-module ModsDisplay
-  class Configuration
-    class Name < Base
-      def delimiter(delimiter = '<br/>')
-        @delimiter ||= delimiter
-      end
-    end
-  end
-end

data/lib/mods_display/configuration/note.rb

@@ -1,9 +0,0 @@
-module ModsDisplay
-  class Configuration
-    class Note < Base
-      def delimiter(delimiter = '<br/>')
-        @delimiter ||= delimiter
-      end
-    end
-  end
-end

data/lib/mods_display/configuration/related_item.rb

@@ -1,9 +0,0 @@
-module ModsDisplay
-  class Configuration
-    class RelatedItem < Base
-      def delimiter(delimiter = '<br/>')
-        @delimiter ||= delimiter
-      end
-    end
-  end
-end

data/lib/mods_display/configuration/subject.rb

@@ -1,13 +0,0 @@
-module ModsDisplay
-  class Configuration
-    class Subject < Base
-      def hierarchical_link(hierarchical_link = false)
-        @hierarchical_link ||= hierarchical_link
-      end
-
-      def delimiter(delimiter = ' &gt; ')
-        @delimiter ||= delimiter
-      end
-    end
-  end
-end

data/lib/mods_display/configuration/title.rb

@@ -1,9 +0,0 @@
-module ModsDisplay
-  class Configuration
-    class Title < Base
-      def delimiter(delimiter = '<br/>')
-        @delimiter ||= delimiter
-      end
-    end
-  end
-end

data/lib/mods_display/configuration.rb

@@ -1,93 +0,0 @@
-# We can probably do something smarter here using const_get to assign
-# special coniguration classes then fall back on the base config class
-module ModsDisplay
-  class Configuration
-    def initialize(&config)
-      instance_eval(&config)
-    end
-
-    def title(&title)
-      @title ||= ModsDisplay::Configuration::Title.new(&title || proc {})
-    end
-
-    def sub_title(&sub_title)
-      @sub_title ||= ModsDisplay::Configuration::Title.new(&sub_title || proc {})
-    end
-
-    def name(&name)
-      @name ||= ModsDisplay::Configuration::Name.new(&name || proc {})
-    end
-
-    def resource_type(&resource_type)
-      @type_of_resource ||= ModsDisplay::Configuration::Base.new(&resource_type || proc {})
-    end
-
-    def genre(&genre)
-      @genre ||= ModsDisplay::Configuration::Genre.new(&genre || proc {})
-    end
-
-    def imprint(&imprint)
-      @imprint ||= ModsDisplay::Configuration::Imprint.new(&imprint || proc {})
-    end
-
-    def language(&language)
-      @language ||= ModsDisplay::Configuration::Base.new(&language || proc {})
-    end
-
-    def description(&description)
-      @description ||= ModsDisplay::Configuration::Base.new(&description || proc {})
-    end
-
-    def cartographics(&cartographics)
-      @cartographics ||= ModsDisplay::Configuration::Base.new(&cartographics || proc {})
-    end
-
-    def abstract(&abstract)
-      @abstract ||= ModsDisplay::Configuration::Base.new(&abstract || proc {})
-    end
-
-    def contents(&contents)
-      @contents ||= ModsDisplay::Configuration::Base.new(&contents || proc {})
-    end
-
-    def audience(&audience)
-      @audience ||= ModsDisplay::Configuration::Base.new(&audience || proc {})
-    end
-
-    def note(&note)
-      @note ||= ModsDisplay::Configuration::Note.new(&note || proc {})
-    end
-
-    def contact(&contact)
-      @contact ||= ModsDisplay::Configuration::Base.new(&contact || proc {})
-    end
-
-    def collection(&collection)
-      @collection ||= ModsDisplay::Configuration::Base.new(&collection || proc {})
-    end
-
-    def related_item(&related_item)
-      @related_item ||= ModsDisplay::Configuration::RelatedItem.new(&related_item || proc {})
-    end
-
-    def nested_related_item(&nested_related_item)
-      @nested_related_item ||= ModsDisplay::Configuration::Base.new(&nested_related_item || proc {})
-    end
-
-    def subject(&subject)
-      @subject ||= ModsDisplay::Configuration::Subject.new(&subject || proc {})
-    end
-
-    def identifier(&identifier)
-      @identifier ||= ModsDisplay::Configuration::Base.new(&identifier || proc {})
-    end
-
-    def location(&location)
-      @location ||= ModsDisplay::Configuration::Base.new(&location || proc {})
-    end
-
-    def access_condition(&access_condition)
-      @access_condition ||= ModsDisplay::Configuration::AccessCondition.new(&access_condition || proc {})
-    end
-  end
-end

data/lib/mods_display/controller_extension.rb

@@ -1,32 +0,0 @@
-module ModsDisplay
-  module ControllerExtension
-    def self.included(base)
-      base.extend ClassMethods
-      base.class_eval do
-        def mods_display_config
-          @mods_display_config || self.class.mods_display_config
-        end
-        if base.respond_to?(:helper_method)
-          helper_method :mods_display_config, :render_mods_display
-        end
-      end
-    end
-
-    def render_mods_display(model)
-      return '' if model.mods_display_xml.nil?
-      ModsDisplay::HTML.new(mods_display_config, model.mods_display_xml, self)
-    end
-
-    private
-
-    module ClassMethods
-      def configure_mods_display(&config)
-        @mods_display_config = ModsDisplay::Configuration.new(&config)
-      end
-
-      def mods_display_config
-        @mods_display_config || ModsDisplay::Configuration.new {}
-      end
-    end
-  end
-end

data/lib/mods_display/helpers/record_helper.rb

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

@@ -1,22 +0,0 @@
-module ModsDisplay
-  module ModelExtension
-    def self.included(base)
-      base.extend ClassMethods
-      base.class_eval do
-        def mods_display_xml
-          xml = self.class.mods_xml_source.call(self)
-          return if xml.nil?
-          mods = Stanford::Mods::Record.new
-          mods.from_str(xml, false)
-          mods
-        end
-      end
-    end
-
-    module ClassMethods
-      def mods_xml_source(&xml)
-        @mods_xml_source ||= xml
-      end
-    end
-  end
-end

data/lib/mods_display/railtie.rb

@@ -1,10 +0,0 @@
-# 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/spec/configuration/access_condition_spec.rb

@@ -1,10 +0,0 @@
-require 'spec_helper'
-
-describe ModsDisplay::Configuration::AccessCondition do
-  it 'should default ignore? to true' do
-    expect(ModsDisplay::Configuration::AccessCondition.new.ignore?).to be true
-  end
-  it 'should set ignore? to false when the display! configuration is set' do
-    expect(ModsDisplay::Configuration::AccessCondition.new { display! }.ignore?).to be false
-  end
-end

data/spec/configuration/base_spec.rb

@@ -1,39 +0,0 @@
-require 'spec_helper'
-
-describe ModsDisplay::Configuration::Base do
-  it 'should set config options w/ a block' do
-    config = ModsDisplay::Configuration::Base.new do
-      label_class 'testing_label_class'
-      value_class 'testing_value_class'
-    end
-    expect(config.label_class).to eq('testing_label_class')
-    expect(config.value_class).to eq('testing_value_class')
-  end
-  describe 'link' do
-    it 'should return an array with a method name and params' do
-      expect(ModsDisplay::Configuration::Base.new do
-        link :my_url_generating_method, q: '"%value%"'
-      end.link).to eq([:my_url_generating_method, { q: '"%value%"' }])
-    end
-  end
-  describe 'delmiter' do
-    it 'should override the default delimiter' do
-      expect(ModsDisplay::Configuration::Base.new do
-        delimiter '<br/>'
-      end.delimiter).to eq('<br/>')
-    end
-    it "should default to ', '" do
-      expect(ModsDisplay::Configuration::Base.new.delimiter).to eq(', ')
-    end
-  end
-  describe 'ignore' do
-    it 'should be set to true if the #ignore! method is called' do
-      expect(ModsDisplay::Configuration::Base.new do
-        ignore!
-      end.ignore?).to be true
-    end
-    it 'should be false by default' do
-      expect(ModsDisplay::Configuration::Base.new.ignore?).to be false
-    end
-  end
-end

data/spec/fake_app.rb

@@ -1,18 +0,0 @@
-# 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/fields/abstract_spec.rb

@@ -1,39 +0,0 @@
-require 'spec_helper'
-
-def mods_display_abstract(mods_record)
-  ModsDisplay::Abstract.new(mods_record, ModsDisplay::Configuration::Base.new, double('controller'))
-end
-
-describe ModsDisplay::Abstract do
-  before(:all) do
-    @link = Stanford::Mods::Record.new.from_str(
-      '<mods><abstract>A link to the library (http://library.stanford.edu) should appear here</abstract></mods>', false
-    ).abstract
-    @email = Stanford::Mods::Record.new.from_str(
-      '<mods><abstract>A link to an email address jdoe@example.com should appear here</abstract></mods>', false
-    ).abstract
-  end
-
-  describe 'labels' do
-    it "should get a default 'Abstract' label" do
-      fields = mods_display_abstract(@link).fields
-      expect(fields.length).to eq(1)
-      expect(fields.first.label).to eq('Abstract:')
-    end
-  end
-
-  describe 'links' do
-    it 'should turn URLs into links' do
-      expect(mods_display_abstract(@link).to_html).to match(/A link to the library \(<a href/)
-      expect(mods_display_abstract(@link).to_html).to match(
-        %r{\(<a href='http://library.stanford.edu'>http://library.stanford.edu</a>\)}
-      )
-      expect(mods_display_abstract(@link).to_html).to match(%r{</a>\) should appear here})
-    end
-    it 'should turn email addresses into mailto links' do
-      expect(mods_display_abstract(@email).to_html).to match(
-        %r{A link to an email address <a href='mailto:jdoe@example.com'>jdoe@example.com</a> should appear here}
-      )
-    end
-  end
-end