mods_display 0.9.1 → 1.0.0.alpha2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mods_display
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.0.alpha2
 platform: ruby
 authors:
 - Jessie Keck
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2021-05-12 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stanford-mods
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: MODS Display is a gem to centralize the display logic of MODS medadata.
 email:
 - jessie.keck@gmail.com
@@ -143,28 +171,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
-- ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/components/mods_display/field_component.html.erb
+- app/components/mods_display/field_component.rb
+- app/components/mods_display/list_field_component.html.erb
+- app/components/mods_display/list_field_component.rb
+- app/components/mods_display/record_component.html.erb
+- app/components/mods_display/record_component.rb
+- app/helpers/mods_display/record_helper.rb
+- app/models/mods_display/record.rb
+- config.ru
 - config/locales/en.yml
 - lib/mods_display.rb
-- lib/mods_display/configuration.rb
-- lib/mods_display/configuration/access_condition.rb
-- lib/mods_display/configuration/base.rb
-- lib/mods_display/configuration/genre.rb
-- lib/mods_display/configuration/imprint.rb
-- lib/mods_display/configuration/name.rb
-- lib/mods_display/configuration/note.rb
-- lib/mods_display/configuration/related_item.rb
-- lib/mods_display/configuration/subject.rb
-- lib/mods_display/configuration/title.rb
-- lib/mods_display/controller_extension.rb
 - lib/mods_display/country_codes.rb
+- lib/mods_display/engine.rb
 - lib/mods_display/fields/abstract.rb
 - lib/mods_display/fields/access_condition.rb
 - lib/mods_display/fields/audience.rb
@@ -191,55 +216,11 @@ 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
-- spec/fields/cartographics_spec.rb
-- spec/fields/collection_spec.rb
-- spec/fields/contact_spec.rb
-- spec/fields/contents_spec.rb
-- spec/fields/description_spec.rb
-- spec/fields/extent_spec.rb
-- spec/fields/form_spec.rb
-- spec/fields/genre_spec.rb
-- spec/fields/geo_spec.rb
-- spec/fields/identifier_spec.rb
-- spec/fields/imprint_spec.rb
-- spec/fields/language_spec.rb
-- spec/fields/location_spec.rb
-- spec/fields/name_spec.rb
-- spec/fields/nested_related_item_spec.rb
-- spec/fields/note_spec.rb
-- spec/fields/related_item_spec.rb
-- spec/fields/resource_type_spec.rb
-- spec/fields/sub_title_spec.rb
-- spec/fields/subject_spec.rb
-- spec/fields/title_spec.rb
-- spec/fixtures/access_condition_fixtures.rb
-- spec/fixtures/cartographics_fixtures.rb
-- spec/fixtures/imprint_fixtures.rb
-- spec/fixtures/name_fixtures.rb
-- spec/fixtures/nested_realted_items_fixtures.rb
-- 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
-- spec/spec_helper.rb
-- spec/test_fr.yml
 homepage: https://github.com/sul-dlss/mods_display
 licenses: []
 metadata: {}
@@ -254,55 +235,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: The MODS Display gem allows implementers to configure a customized display
   of MODS metadata.  This display implements the specifications defined at Stanford
   for how to display MODS.
-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
-- spec/fields/cartographics_spec.rb
-- spec/fields/collection_spec.rb
-- spec/fields/contact_spec.rb
-- spec/fields/contents_spec.rb
-- spec/fields/description_spec.rb
-- spec/fields/extent_spec.rb
-- spec/fields/form_spec.rb
-- spec/fields/genre_spec.rb
-- spec/fields/geo_spec.rb
-- spec/fields/identifier_spec.rb
-- spec/fields/imprint_spec.rb
-- spec/fields/language_spec.rb
-- spec/fields/location_spec.rb
-- spec/fields/name_spec.rb
-- spec/fields/nested_related_item_spec.rb
-- spec/fields/note_spec.rb
-- spec/fields/related_item_spec.rb
-- spec/fields/resource_type_spec.rb
-- spec/fields/sub_title_spec.rb
-- spec/fields/subject_spec.rb
-- spec/fields/title_spec.rb
-- spec/fixtures/access_condition_fixtures.rb
-- spec/fixtures/cartographics_fixtures.rb
-- spec/fixtures/imprint_fixtures.rb
-- spec/fixtures/name_fixtures.rb
-- spec/fixtures/nested_realted_items_fixtures.rb
-- 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
-- spec/spec_helper.rb
-- spec/test_fr.yml
+test_files: []

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