mods_display 0.10.1 → 1.0.0.alpha1

data/lib/mods_display/fields/nested_related_item.rb

@@ -18,30 +18,19 @@ module ModsDisplay
       end
     end
 
-    def to_html
-      return if fields.empty? || @config.ignore?
-      @to_html ||= begin
-        output = ''
-        fields.each do |field|
-          next unless field.values.any? { |f| f && !f.empty? }
-          output << "<dt#{label_class} #{sanitized_field_title(field.label)}>#{field.label}</dt>"
-          output << "<dd#{value_class}>"
-          output << '<ul class="mods_display_nested_related_items">'
-          output << field.values.map do |val|
-            "<li class='mods_display_nested_related_item open'>#{link_urls_and_email(val.to_s)}</li>"
-          end.join
-          output << '</ul>'
-          output << '</dd>'
-        end
-        output
-      end
+    def to_html(view_context = ApplicationController.renderer)
+      helpers = view_context.respond_to?(:simple_format) ? view_context : ApplicationController.new.view_context
+
+      component = ModsDisplay::FieldComponent.with_collection(fields, value_transformer: ->(value) { helpers.link_urls_and_email(value.to_s) })
+
+      view_context.render component
     end
 
     private
 
     def related_item_mods_object(value)
       mods = ::Stanford::Mods::Record.new.tap { |r| r.from_str("<mods>#{value.children.to_xml}</mods>", false) }
-      related_item = ModsDisplay::HTML.new(@config, mods, @klass)
+      related_item = ModsDisplay::HTML.new(mods)
 
       ModsDisplay::Values.new(
         label: related_item_label(value),

data/lib/mods_display/fields/note.rb

@@ -9,6 +9,10 @@ module ModsDisplay
 
     private
 
+    def delimiter
+      '<br />'
+    end
+
     def note_fields
       @values.select do |value|
         (!value.attributes['type'].respond_to?(:value) ||

data/lib/mods_display/fields/related_item.rb

@@ -20,6 +20,10 @@ module ModsDisplay
 
     private
 
+    def delimiter
+      '<br />'
+    end
+
     def process_location(item)
       ModsDisplay::Values.new(label: related_item_label(item), values: [item.location.text.strip])
     end

data/lib/mods_display/fields/sub_title.rb

@@ -1,7 +1,7 @@
 module ModsDisplay
-  class SubTitle < Field
-    def fields
-      ModsDisplay::Title.new(@values[1, @values.length], @config, @klass).fields
+  class SubTitle < ModsDisplay::Title
+    def initialize(values)
+      super(values[1..])
     end
   end
 end

data/lib/mods_display/fields/subject.rb

@@ -27,44 +27,14 @@ module ModsDisplay
     end
 
     # Would really like to clean this up, but it works and is tested for now.
-    def to_html
-      return nil if fields.empty? || @config.ignore?
-      output = ''
-      fields.each do |field|
-        output << "<dt#{label_class} #{sanitized_field_title(field.label)}>#{field.label}</dt>"
-        output << "<dd#{value_class}>"
-        subs = []
-        field.values.each do |subjects|
-          buffer = []
-          sub_parts = []
-          subjects.each do |val|
-            if val.is_a?(ModsDisplay::Name::Person)
-              buffer << val.name
-            else
-              buffer << val
-            end
-            if @config.link && @config.hierarchical_link
-              if val.is_a?(ModsDisplay::Name::Person)
-                sub_parts << link_to_value(val.name, buffer.join(' '))
-              else
-                sub_parts << link_to_value(val, buffer.join(' '))
-              end
-            elsif @config.link
-              if val.is_a?(ModsDisplay::Name::Person)
-                sub_parts << link_to_value(val.name)
-              else
-                sub_parts << link_to_value(val.to_s)
-              end
-            else
-              sub_parts << val.to_s
-            end
-          end
-          subs << sub_parts.join(@config.delimiter)
-        end
-        output << subs.join('<br/>')
-        output << '</dd>'
-      end
-      output
+    def to_html(view_context = ApplicationController.renderer)
+      component = ModsDisplay::FieldComponent.with_collection(
+        fields,
+        delimiter: '<br />'.html_safe,
+        value_transformer: ->(value) { value.join(' > ') }
+      )
+
+      view_context.render component
     end
 
     def process_hierarchicalGeographic(element)
@@ -72,13 +42,17 @@ module ModsDisplay
     end
 
     def process_name(element)
-      name = ModsDisplay::Name.new([element], @config, @klass).fields.first
+      name = ModsDisplay::Name.new([element]).fields.first
 
       name.values.first if name
     end
 
     private
 
+    def delimiter
+      ' &gt; '
+    end
+
     def values_from_subjects(element)
       return_values = []
       selected_subjects(element).each do |child|

data/lib/mods_display/fields/title.rb

@@ -15,6 +15,10 @@ module ModsDisplay
 
     private
 
+    def delimiter
+      '<br />'
+    end
+
     def assemble_title(element)
       return displayForm(element) if displayForm(element)
 

data/lib/mods_display/fields/values.rb

@@ -1,10 +1,10 @@
 module ModsDisplay
   class Values
     attr_accessor :label, :values
-    def initialize(values)
-      values.each do |key, value|
-        send("#{key}=".to_sym, value) if [:label, :values].include?(key)
-      end
+
+    def initialize(label: nil, values: [])
+      @label = label
+      @values = values
     end
   end
 end

data/lib/mods_display/html.rb

@@ -1,136 +1,83 @@
 module ModsDisplay
   class HTML
-    def initialize(config, xml, klass)
-      @config = config
+    MODS_DISPLAY_FIELD_MAPPING = {
+      title: :title_info,
+      subTitle: :title_info,
+      name: :plain_name,
+      resourceType: :typeOfResource,
+      genre: :genre,
+      form: :physical_description,
+      extent: :physical_description,
+      geo: :extension,
+      imprint: :origin_info,
+      language: :language,
+      description: :physical_description,
+      cartographics: :subject,
+      abstract: :abstract,
+      contents: :tableOfContents,
+      audience: :targetAudience,
+      note: :note,
+      contact: :note,
+      collection: :related_item,
+      nestedRelatedItem: :related_item,
+      relatedItem: :related_item,
+      subject: :subject,
+      identifier: :identifier,
+      location: :location,
+      accessCondition: :accessCondition
+    }.freeze
+
+    def initialize(xml)
       @stanford_mods = xml
       @xml = xml.mods_ng_xml
-      @klass = klass
     end
 
     def title
-      unless mods_field(@xml, :title).fields.empty?
-        return mods_field(@xml, :title).fields.first.values
+      unless mods_field(:title).fields.empty?
+        return mods_field(:title).fields.first.values
       end
       ''
     end
 
+    def render_in(view_context)
+      body(view_context)
+    end
+
     # Need to figure out how to get the 1st title out of the list.
     # Maybe have a separate class that will omit the first tite natively
     # and replace the first key in the the fields list with that.
-    def body
-      output = '<dl>'
-      body_fields = mods_display_fields.dup
-      body_fields[0] = :subTitle
-      body_fields.each do |field_key|
-        field = mods_field(@xml, field_key)
-        output << field.to_html unless field.nil? || field.to_html.nil?
-      end
-      output << '</dl>'
-    end
-
-    def to_html
-      output = '<dl>'
-      mods_display_fields.each do |field_key|
-        field = mods_field(@xml, field_key)
-        output << field.to_html unless field.nil? || field.to_html.nil?
-      end
-      output << '</dl>'
+    def body(view_context = ApplicationController.renderer)
+      view_context.render ModsDisplay::RecordComponent.new(record: self)
     end
 
-    def method_missing(method_name, *args, &block)
-      if to_s.respond_to?(method_name)
-        to_html.send(method_name, *args, &block)
-      elsif method_name == :subTitle || mods_display_fields.include?(method_name)
-        field = mods_field(@xml, method_name)
-        return field if (args.dig(0, :raw))
-        field.fields
-      else
-        super
-      end
+    # @deprecated
+    def to_html(view_context = ApplicationController.renderer)
+      fields = [:title] + ModsDisplay::RecordComponent::DEFAULT_FIELDS - [:subTitle]
+      view_context.render ModsDisplay::RecordComponent.new(record: self, fields: fields)
     end
 
-    private
+    MODS_DISPLAY_FIELD_MAPPING.except(:title).each do |key, _value|
+      define_method(key) do |raw: false|
+        field = mods_field(key)
+        next field if raw
 
-    def mods_field(xml, field_key)
-      if xml.respond_to?(mods_display_field_mapping[field_key])
-        field = xml.send(mods_display_field_mapping[field_key])
-        ModsDisplay.const_get(
-          "#{field_key.slice(0, 1).upcase}#{field_key.slice(1..-1)}"
-        ).new(field, field_config(field_key), @klass)
-      elsif @stanford_mods.respond_to?(field_key)
-        ModsDisplay.const_get(
-          "#{field_key.slice(0, 1).upcase}#{field_key.slice(1..-1)}"
-        ).new(@stanford_mods, field_config(field_key), @klass)
+        field.fields
       end
     end
 
-    def field_config(field_key)
-      @config.send(field_key_translation[field_key] || field_key)
-    rescue
-      ModsDisplay::Configuration::Base.new
-    end
+    def mods_field(key)
+      raise ArgumentError unless MODS_DISPLAY_FIELD_MAPPING[key] && @xml.respond_to?(MODS_DISPLAY_FIELD_MAPPING[key])
 
-    def mods_display_fields
-      [:title,
-       :name,
-       :language,
-       :imprint,
-       :resourceType,
-       :genre,
-       :form,
-       :extent,
-       :geo,
-       :description,
-       :cartographics,
-       :abstract,
-       :contents,
-       :audience,
-       :note,
-       :contact,
-       :collection,
-       :nestedRelatedItem,
-       :relatedItem,
-       :subject,
-       :identifier,
-       :location,
-       :accessCondition
-      ]
+      field = @xml.public_send(MODS_DISPLAY_FIELD_MAPPING[key])
+      mods_field_class(key).new(field)
     end
 
-    def mods_display_field_mapping
-      { title: :title_info,
-        subTitle: :title_info,
-        name: :plain_name,
-        resourceType: :typeOfResource,
-        genre: :genre,
-        form: :physical_description,
-        extent: :physical_description,
-        geo: :extension,
-        imprint: :origin_info,
-        language: :language,
-        description: :physical_description,
-        cartographics: :subject,
-        abstract: :abstract,
-        contents: :tableOfContents,
-        audience: :targetAudience,
-        note: :note,
-        contact: :note,
-        collection: :related_item,
-        nestedRelatedItem: :related_item,
-        relatedItem: :related_item,
-        subject: :subject,
-        identifier: :identifier,
-        location: :location,
-        accessCondition: :accessCondition }
-    end
+    private
 
-    def field_key_translation
-      { subTitle: :sub_title,
-        resourceType: :resource_type,
-        relatedItem: :related_item,
-        accessCondition: :access_condition,
-        nestedRelatedItem: :nested_related_item
-      }
+    def mods_field_class(key)
+      ModsDisplay.const_get(
+        "#{key.slice(0, 1).upcase}#{key.slice(1..-1)}"
+      )
     end
   end
 end

data/lib/mods_display/version.rb

@@ -1,3 +1,3 @@
 module ModsDisplay
-  VERSION = '0.10.1'
+  VERSION = '1.0.0.alpha1'
 end

data/lib/mods_display.rb

@@ -1,20 +1,8 @@
 require 'mods_display/version'
-require 'mods_display/controller_extension'
 require 'mods_display/html'
-require 'mods_display/model_extension'
 require 'mods_display/country_codes'
 require 'mods_display/relator_codes'
 require 'mods_display/related_item_concerns'
-require 'mods_display/configuration'
-require 'mods_display/configuration/base'
-require 'mods_display/configuration/access_condition'
-require 'mods_display/configuration/imprint'
-require 'mods_display/configuration/genre'
-require 'mods_display/configuration/name'
-require 'mods_display/configuration/note'
-require 'mods_display/configuration/related_item'
-require 'mods_display/configuration/subject'
-require 'mods_display/configuration/title'
 require 'mods_display/fields/field'
 require 'mods_display/fields/abstract'
 require 'mods_display/fields/access_condition'
@@ -38,8 +26,8 @@ require 'mods_display/fields/note'
 require 'mods_display/fields/related_item'
 require 'mods_display/fields/resource_type'
 require 'mods_display/fields/subject'
-require 'mods_display/fields/sub_title'
 require 'mods_display/fields/title'
+require 'mods_display/fields/sub_title'
 require 'mods_display/fields/values'
 
 require 'stanford-mods'
@@ -50,13 +38,4 @@ 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
+require 'mods_display/engine'

data/mods_display.gemspec

@@ -1,7 +1,5 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'mods_display/version'
+# frozen_string_literal: true
+require_relative "lib/mods_display/version"
 
 Gem::Specification.new do |gem|
   gem.name          = 'mods_display'
@@ -12,13 +10,20 @@ Gem::Specification.new do |gem|
   gem.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.'
   gem.homepage      = 'https://github.com/sul-dlss/mods_display'
 
-  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(spec)/})
-  gem.require_paths = ['lib']
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  gem.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  gem.bindir = "exe"
+  gem.executables = gem.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  gem.require_paths = ["lib"]
 
   gem.add_dependency 'stanford-mods', '~> 2.1'
   gem.add_dependency 'i18n'
+  gem.add_dependency 'view_component'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 3.0'
@@ -26,5 +31,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'capybara'
   gem.add_development_dependency 'byebug'
-  gem.add_development_dependency 'rails', '~> 6.0'
+  gem.add_development_dependency 'rails', ENV['RAILS_VERSION'] || '~> 6.0'
+  gem.add_development_dependency 'combustion', '~> 1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mods_display
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 1.0.0.alpha1
 platform: ruby
 authors:
 - Jessie Keck
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2021-07-07 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: []