mods_display 0.0.1.beta1

data/lib/mods_display/fields/contents.rb

@@ -0,0 +1,7 @@
+class ModsDisplay::Contents < ModsDisplay::Field
+
+  def label
+    super || "Table of Contents"
+  end
+
+end

data/lib/mods_display/fields/description.rb

@@ -0,0 +1,30 @@
+class ModsDisplay::Description < ModsDisplay::Field
+
+  def fields
+    description_fields.map do |description|
+      ModsDisplay::Values.new({:label => (label || description_label(description) || labels[description.name.to_sym] || "Physical Description"),
+                               :values => [description.text]})
+    end
+  end
+
+  def description_label(element)
+    element.attributes["displayLabel"].value if element.attributes["displayLabel"].respond_to?(:value)
+  end
+
+  private
+
+  def description_fields
+    @value.children.select do |child|
+      labels.keys.include?(child.name.to_sym)
+    end
+  end
+
+  def labels
+    {:form          => "Form",
+     :extent        => "Extent",
+     :digitalOrigin => "Digital Origin",
+     :note          => "Note"
+     }
+  end
+
+end

data/lib/mods_display/fields/field.rb

@@ -0,0 +1,89 @@
+class ModsDisplay::Field
+  def initialize(value, config, klass)
+    @value = value
+    @config = config
+    @klass = klass
+  end
+
+  def fields
+    @value.map do |val|
+      ModsDisplay::Values.new(:label => displayLabel(val), :values => [text || val.text].flatten)
+    end
+  end
+
+  def label
+    return nil if @value.nil?
+    displayLabel(@value.first)
+  end
+
+  def text
+    return nil if @value.nil?
+    if displayForm(@value)
+      displayForm(@value).text
+    end
+  end
+
+  def to_html
+    return nil if fields.empty?
+    output = ""
+    fields.each do |field|
+      output << "<dt#{label_class} title='#{field.label}'>#{field.label}:</dt>"
+      output << "<dd#{value_class}>"
+        output << field.values.map do |val|
+          @config.link ? link_to_value(val.to_s) : val.to_s
+        end.join(@config.delimiter)
+      output << "</dd>"
+    end
+    output
+  end
+
+  private
+
+  def label_class
+    " class='#{@config.label_class}'" unless @config.label_class == ""
+  end
+
+  def value_class
+    " class='#{@config.value_class}'" unless @config.value_class == ""
+  end
+
+  def link_to_value(link_text, link_href=nil)
+    "<a href='#{@klass.send(@config.link[0], replace_tokens(@config.link[1], link_href || link_text))}'>#{link_text}</a>"
+  end
+
+  def displayForm(element)
+    element.children.find{|c| c.name == "displayForm"}
+  end
+
+  def displayLabel(element)
+    if (element.respond_to?(:attributes) and
+        element.attributes["displayLabel"].respond_to?(:value))
+      element.attributes["displayLabel"].value
+    end
+  end
+
+  def replace_tokens(object, value)
+    object = object.dup
+    if object.is_a?(Hash)
+      object.each do |k,v|
+        object[k] = replace_token(v, value)
+      end
+    elsif object.is_a?(String)
+      object = replace_token(object, value)
+    end
+    object
+  end
+
+  def replace_token(string, value)
+    string = string.dup
+    tokens.each do |token|
+      string.gsub!(token, value)
+    end
+    string
+  end
+
+  def tokens
+    ["%value%"]
+  end
+
+end

data/lib/mods_display/fields/format.rb

@@ -0,0 +1,34 @@
+class ModsDisplay::Format < ModsDisplay::Field
+
+  def fields
+    return [] if (text.nil? and @value.text.strip.empty?)
+    return_values = @value.map{|v| v.text }
+    return_values = [text] unless text.nil?
+    [ModsDisplay::Values.new(:label => label || 'Format', :values => return_values)]
+  end
+
+  def text
+    return super unless super.nil?
+  end
+
+  def to_html
+    output = ""
+    fields.each do |field|
+      output << "<dt#{label_class} title='#{field.label}'>#{field.label}:</dt>"
+      output << "<dd#{value_class}>"
+        field.values.map do |val|
+          output << "<span class='#{self.class.format_class(val)}'>#{val}</span>"
+        end.join(@config.delimiter)
+      output << "</dd>"
+    end
+    output
+  end
+
+  private
+
+  def self.format_class(format)
+    return format if format.nil?
+    format.strip.downcase.gsub(/\/|\\|\s+/, "_")
+  end
+
+end

data/lib/mods_display/fields/identifier.rb

@@ -0,0 +1,60 @@
+class ModsDisplay::Identifier < ModsDisplay::Field
+  
+  def fields
+    return_values = []
+    current_label = nil
+    prev_label = nil
+    buffer = []
+    @value.each_with_index do |val, index|
+      current_label = (displayLabel(val) || identifier_label(val))
+      if @value.length == 1
+        return_values << ModsDisplay::Values.new(:label => current_label, :values => [val.text])
+      elsif index == (@value.length-1)
+        # need to deal w/ when we have a last element but we have separate labels in the buffer.
+        if current_label != prev_label
+          return_values << ModsDisplay::Values.new(:label => prev_label, :values => buffer.flatten)
+          return_values << ModsDisplay::Values.new(:label => current_label, :values => [val.text])
+        else
+          buffer << val.text
+          return_values << ModsDisplay::Values.new(:label => current_label, :values => buffer.flatten)
+        end
+      elsif prev_label and (current_label != prev_label)
+        return_values << ModsDisplay::Values.new(:label => prev_label, :values => buffer.flatten)
+        buffer = []
+      end
+      buffer << val.text
+      prev_label = current_label
+    end
+    return_values
+  end
+  
+  private
+  
+  def identifier_label(element)
+    if element.attributes["type"].respond_to?(:value)
+      return identifier_labels[element.attributes["type"].value] || element.attributes["type"].value
+    end
+    "Identifier"
+  end
+  
+  def identifier_labels
+    {"local"                     => "Identifier",
+     "isbn"                      => "ISBN",
+     "issn"                      => "ISSN",
+     "issn-l"                    => "ISSN",
+     "doi"                       => "DOI",
+     "hdl"                       => "Handle",
+     "isrc"                      => "ISRC",
+     "ismn"                      => "ISMN",
+     "issue number"              => "Issue Number",
+     "lccn"                      => "LCCN",
+     "matrix number"             => "Matrix Number",
+     "music publisher"           => "Music Publisher",
+     "music plate"               => "Music Plate",
+     "sici"                      => "SICI",
+     "upc"                       => "UPC",
+     "videorecording identifier" => "Videorecording Identifier",
+     "stock number"              => "Stock Number"}
+  end
+
+end

data/lib/mods_display/fields/imprint.rb

@@ -0,0 +1,68 @@
+class ModsDisplay::Imprint < ModsDisplay::Field
+
+  def fields
+    return_values = []
+    @value.each do |val|
+      if imprint_display_form(val)
+        return_values << imprint_display_form(val)
+      else
+        place = nil
+        publisher = nil
+        placePub = nil
+        place = val.place.map do |p|
+          p.text unless p.text.strip.empty?
+        end.compact.join(" : ").strip unless val.place.text.strip.empty?
+        publisher = val.publisher.map do |p|
+          p.text unless p.text.strip.empty?
+        end.compact.join(" : ").strip unless val.publisher.text.strip.empty?
+        placePub = [place, publisher].compact.join(" : ")
+        placePub = nil if placePub.strip.empty?
+        parts = val.children.select do |child|
+          ["dateCreated", "dateIssued", "dateCaptured", "dateOther"].include?(child.name) and !child.attributes.has_key?("encoding")
+        end.map do |child|
+          child.text.strip unless child.text.strip.empty?
+        end.compact.join(", ")
+        parts = nil if parts.strip.empty?
+        unless [placePub, parts].compact.join(", ").strip.empty?
+          return_values << ModsDisplay::Values.new(:label => displayLabel(val) || "Imprint", :values => [[placePub, parts].compact.join(", ")])
+        end
+        if other_pub_info(val).length > 0
+          other_pub_info(val).each do |pub_info|
+            return_values << ModsDisplay::Values.new(:label => displayLabel(val) || pub_info_labels[pub_info.name.to_sym], :values => [pub_info.text.strip])
+          end
+        end
+      end
+    end
+    return_values
+  end
+
+  def other_pub_info(element)
+    element.children.select do |child|
+      pub_info_parts.include?(child.name.to_sym)
+    end
+  end
+  
+  def imprint_display_form(element)
+    display_form = element.children.find do |child|
+      child.name == "displayForm"
+    end
+    ModsDisplay::Values.new(:label => displayLabel(element) || "Imprint", :values => [display_form.text]) if display_form
+  end
+
+  private
+
+  def pub_info_parts
+    pub_info_labels.keys
+  end
+
+  def pub_info_labels
+    {:dateValid     => "Date Valid",
+     :dateModified  => "Date Modified",
+     :copyrightDate => "Copyright Date",
+     :edition       => "Edition",
+     :issuance      => "Issuance",
+     :frequency     => "Frequency"
+    }
+  end
+
+end

data/lib/mods_display/fields/language.rb

@@ -0,0 +1,33 @@
+class ModsDisplay::Language < ModsDisplay::Field
+  def label
+    return super unless super.nil?
+    "Language"
+  end
+
+  def fields
+    return [] if @value.languageTerm.length < 1 or @value.languageTerm.text.strip.empty?
+    return_values = []
+    @value.each do |val|
+      languages = []
+      val.languageTerm.select do |term|
+        term.attributes["type"].respond_to?(:value) && term.attributes["type"].value == "code"
+      end.each do |term|
+        languages << language_codes[term.text]
+      end
+      return_values << ModsDisplay::Values.new(:label => displayLabel(val) || "Language", :values => languages)
+    end
+    return_values
+  end
+
+  def text
+    return super unless super.nil?
+    language_codes[@value.text.strip] || @value.text.strip
+  end
+
+  private
+
+  def language_codes
+    SEARCHWORKS_LANGUAGES
+  end
+
+end

data/lib/mods_display/fields/location.rb

@@ -0,0 +1,25 @@
+class ModsDisplay::Location < ModsDisplay::Field
+  
+  def fields
+    return_values = []
+    @value.each do |val|
+      return_values << ModsDisplay::Values.new(:label => label || location_label(val), :values => [val.text])
+    end
+    return_values
+  end
+  
+  private
+  
+  def location_label(element)
+    if element.attributes["type"].respond_to?(:value) && location_labels.has_key?(element.attributes["type"].value)
+      location_labels[element.attributes["type"].value]
+    else
+      "Location"
+    end
+  end
+  
+  def location_labels
+    {"repository" => "Repository"}
+  end
+
+end

data/lib/mods_display/fields/name.rb

@@ -0,0 +1,97 @@
+class ModsDisplay::Name < ModsDisplay::Field
+
+  def fields
+    return_values = []
+    current_label = nil
+    prev_label = nil
+    buffer = []
+    @value.each_with_index do |val, index|
+      current_label = (displayLabel(val) || name_label(val))
+      people = []
+      role = nil
+      if val.role.length > 0 and val.role.roleTerm.length > 0
+        role = val.role.roleTerm.find do |term|
+          term.attributes["type"].respond_to?(:value) and
+          term.attributes["type"].value == "text"
+        end
+      end
+      if val.displayForm.length > 0
+        people << ModsDisplay::Name::Person.new(:name => val.displayForm.text, :role => role)
+      else
+        name_parts = val.namePart.map do |name_part|
+          name_part.text
+        end.join(", ")
+        people << ModsDisplay::Name::Person.new(:name => name_parts, :role => role)
+      end
+      if @value.length == 1
+        return_values << ModsDisplay::Values.new(:label => current_label, :values => people.flatten)
+      elsif index == (@value.length-1)
+        # need to deal w/ when we have a last element but we have separate labels in the buffer.
+        if current_label != prev_label
+          return_values << ModsDisplay::Values.new(:label => prev_label, :values => buffer.flatten)
+          return_values << ModsDisplay::Values.new(:label => current_label, :values => people.flatten)
+        else
+          buffer << people
+          return_values << ModsDisplay::Values.new(:label => current_label, :values => buffer.flatten)
+        end
+      elsif prev_label and (current_label != prev_label)
+        return_values << ModsDisplay::Values.new(:label => prev_label, :values => buffer.flatten)
+        buffer = []
+      end
+      buffer << people
+      prev_label = current_label
+    end
+    return_values
+  end
+
+  def to_html
+    return nil if fields.empty?
+    output = ""
+    fields.each do |field|
+      output << "<dt#{label_class} title='#{field.label}'>#{field.label}:</dt>"
+      output << "<dd#{value_class}>"
+        output << field.values.map do |val|
+          if @config.link
+            txt = link_to_value(val.name)
+            txt << " (#{val.role})" if val.role
+            txt
+          else
+            val.to_s
+          end
+        end.join(@config.delimiter)
+      output << "</dd>"
+    end
+    output
+  end
+
+  private
+
+  def name_label(element)
+    if element.attributes.has_key?("type") && name_labels.has_key?(element.attributes["type"].value)
+      return name_labels[element.attributes["type"].value]
+    end
+    "Creator/Contributor"
+  end
+
+  def name_labels
+    {"personal"   => "Author/Creator",
+     "corporate"  => "Corporate Author",
+     "conference" => "Meeting",
+     "family"     => "Family Author"}
+  end
+  
+  class Person
+    attr_accessor :name, :role
+    def initialize(data)
+      @name = data[:name]
+      @role = data[:role] ? data[:role].text : nil
+    end
+    
+    def to_s
+      text = @name.dup
+      text << " (#{@role})" if @role
+      text
+    end
+  end
+
+end