mods_display 0.0.1.beta1

data/lib/mods_display/fields/note.rb

@@ -0,0 +1,49 @@
+class ModsDisplay::Note < ModsDisplay::Field
+  
+  def fields
+    return_values = []
+    current_label = nil
+    prev_label = nil
+    buffer = []
+    @value.each_with_index do |val, index|
+      current_label = (displayLabel(val) || note_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 note_label(element)
+    if element.attributes["type"].respond_to?(:value)
+      return note_labels[element.attributes["type"].value] || element.attributes["type"].value
+    end
+    "Note"
+  end
+  
+  def note_labels
+    {"statement of responsibility" => "Statement of Responsibility",
+     "date/sequential designation" => "Date/Sequential Designation",
+     "references"                  => "References",
+     "bibliography"                => "Bibliography",
+     "preferred citation"          => "Preferred citation"}
+  end
+
+end

data/lib/mods_display/fields/related_item.rb

@@ -0,0 +1,24 @@
+class ModsDisplay::RelatedItem < ModsDisplay::Field
+
+  def fields
+    return_values = []
+    @value.each do |val|
+      unless (val.typeOfResource.length > 0 and
+              val.typeOfResource.attributes.length > 0 and
+              val.typeOfResource.attributes.first.has_key?("collection") and
+              val.typeOfResource.attributes.first["collection"].value == "yes")              
+        if val.titleInfo.length > 0
+          title = val.titleInfo.text.strip
+          return_text = title
+          location = nil
+          location = val.location.url.text if (val.location.length > 0 and
+                                               val.location.url.length > 0)
+          return_text = "<a href='#{location}'>#{title}</a>" if location
+          return_values << ModsDisplay::Values.new(:label => displayLabel(val) || "Related Item", :values => [return_text])
+        end
+      end
+    end
+    return_values
+  end
+
+end

data/lib/mods_display/fields/related_location.rb

@@ -0,0 +1,14 @@
+class ModsDisplay::RelatedLocation < ModsDisplay::Field
+
+
+  def fields
+    return_values = []
+    @value.each do |val|
+      if val.location.length > 0
+        return_values << ModsDisplay::Values.new(:label => displayLabel(val) || "Location", :values => [val.location.text.strip])
+      end
+    end
+    return_values
+  end
+
+end

data/lib/mods_display/fields/subject.rb

@@ -0,0 +1,103 @@
+class ModsDisplay::Subject < ModsDisplay::Field
+  
+  def fields
+    return_values = []
+    @value.each do |val|
+      return_text = []
+      selected_subjects(val).each do |child|
+        if self.respond_to?(:"process_#{child.name}")
+          return_text << self.send(:"process_#{child.name}", child)
+        else
+          if child.text.include?("--")
+            return_text << child.text.split("--").map{|t| t.strip }
+          else
+            return_text << child.text
+          end
+        end
+      end
+      unless return_text.empty?
+        return_values << return_text.flatten
+      end
+    end
+    return [] if return_values.empty?
+    [ModsDisplay::Values.new(:label => "Subject", :values => return_values)]
+  end
+  
+  # Would really like to clean this up, but it works and is tested for now.
+  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}>"
+        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 and @config.hierarchical_link
+              if val.is_a?(ModsDisplay::Name::Person)
+                txt = link_to_value(val.name, buffer.join(' '))
+                txt << " (#{val.role})" if val.role
+                sub_parts << txt
+              else
+                sub_parts << link_to_value(val, buffer.join(' '))
+              end
+            elsif @config.link
+              if val.is_a?(ModsDisplay::Name::Person)
+                txt = link_to_value(val.name)
+                txt << " (#{val.role})" if val.role
+                sub_parts << txt
+              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
+  end
+
+  def process_hierarchicalGeographic(element)
+    values_from_subjects(element)
+  end
+  
+  def process_name(element)
+    ModsDisplay::Name.new([element], @config, @klass).fields.first.values.first
+  end
+  
+  private
+
+  def values_from_subjects(element)
+    return_values = []
+    selected_subjects(element).each do |child|
+      if child.text.include?("--")
+        return_values << child.text.split("--").map{|t| t.strip }
+      else
+        return_values << child.text.strip
+      end
+    end
+    return_values
+  end
+  
+  def selected_subjects(element=@value)
+    element.children.select do |child|
+      !omit_elements.include?(child.name.to_sym)
+    end
+  end
+  
+  def omit_elements
+    [:cartographics, :geographicCode, :text]
+  end
+  
+end

data/lib/mods_display/fields/title.rb

@@ -0,0 +1,49 @@
+class ModsDisplay::Title < ModsDisplay::Field
+
+  
+  def fields
+    return_values = []
+    @value.each do |val|
+      if displayForm(val)
+        return_values << ModsDisplay::Values.new(:label => displayLabel(val) || title_label(val), :values => [displayForm(val).text])
+      else
+        nonSort = nil
+        title = nil
+        subTitle = nil
+        nonSort = val.nonSort.text.strip unless val.nonSort.text.strip.empty?
+        title = val.title.text.strip unless val.title.text.strip.empty?
+        subTitle = val.subTitle.text unless val.subTitle.text.strip.empty?
+        preSubTitle = [nonSort, title].compact.join(" ")
+        preSubTitle = nil if preSubTitle.strip.empty?
+        preParts = [preSubTitle, subTitle].compact.join(" : ")
+        preParts = nil if preParts.strip.empty?
+        parts = val.children.select do |child|
+          ["partName", "partNumber"].include?(child.name)
+        end.map do |child|
+          child.text
+        end.compact.join(", ")
+        parts = nil if parts.strip.empty?
+        return_values << ModsDisplay::Values.new(:label => displayLabel(val) || title_label(val), :values => [[preParts, parts].compact.join(". ")])
+      end
+    end
+    return_values
+  end
+
+  private
+
+  def title_label(element)
+    if (element.attributes["type"].respond_to?(:value) and
+        title_labels.has_key?(element.attributes["type"].value))
+      return title_labels[element.attributes["type"].value]
+    end
+    "Title"
+  end
+
+  def title_labels
+    {"abbreviated" => "Abbreviated Title",
+     "translated"  => "Translated Title",
+     "alternative" => "Alternative Title",
+     "uniform"     => "Uniform Title"}
+  end
+
+end

data/lib/mods_display/fields/values.rb

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

data/lib/mods_display/html.rb

@@ -0,0 +1,87 @@
+class ModsDisplay::HTML
+  attr_reader :title, :body
+  def initialize(config, xml, klass)
+    @config = config
+    @xml = xml
+    @klass = klass
+  end
+  
+  def title
+    unless mods_field(@xml, :title).fields.empty?
+      return mods_field(@xml, :title).fields.first.values
+    end
+    ""
+  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>"
+    mods_display_fields.each do |field_key|
+      unless mods_field(@xml, field_key).to_html.nil?
+        output << mods_field(@xml, field_key).to_html
+      end
+    end
+    output << "</dl>"
+  end
+  
+  def to_html
+    output = "<dl>"
+    mods_display_fields.each do |field_key|
+      unless mods_field(@xml, field_key).to_html.nil?
+        output << mods_field(@xml, field_key).to_html
+      end
+    end
+    output << "</dl>"
+  end
+  
+  def method_missing(method_name, *args, &block)
+    if self.to_s.respond_to?(method_name)
+      self.to_html.send(method_name, *args, &block)
+    else
+      super
+    end
+  end
+  
+  private
+  
+  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)
+    end
+  end
+  
+  def field_config(field_key)
+    begin
+      @config.send(field_key)
+    rescue
+      ModsDisplay::Configuration::Base.new
+    end
+  end
+  
+  def mods_display_fields
+    [:title, :name, :format, :imprint, :language, :description, :cartographics, :abstract, :contents, :audience, :note, :collection, :relatedLocation, :relatedItem, :subject, :identifier, :location]
+  end
+  
+  def mods_display_field_mapping
+   {:title           => :title_info,
+    :name            => :plain_name,
+    :format          => :typeOfResource,
+    :imprint         => :origin_info,
+    :language        => :language,
+    :description     => :physical_description,
+    :cartographics   => :subject,
+    :abstract        => :abstract,
+    :contents        => :tableOfContents,
+    :audience        => :targetAudience,
+    :note            => :note,
+    :collection      => :related_item,
+    :relatedLocation => :related_item,
+    :relatedItem     => :related_item,
+    :subject         => :subject,
+    :identifier      => :identifier,
+    :location        => :location}
+  end
+end

data/lib/mods_display/model_extension.rb

@@ -0,0 +1,20 @@
+module ModsDisplay::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)
+      end
+    end
+  end
+
+  module ClassMethods
+    def mods_xml_source &xml
+      @mods_xml_source ||= xml
+    end
+  end
+end

data/lib/mods_display/version.rb

@@ -0,0 +1,3 @@
+module ModsDisplay
+  VERSION = "0.0.1.beta1"
+end

data/mods_display.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mods_display/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mods_display"
+  gem.version       = ModsDisplay::VERSION
+  gem.authors       = ["Jessie Keck"]
+  gem.email         = ["jessie.keck@gmail.com"]
+  gem.description   = %q{MODS Display is a gem to centralize the display logic of MODS medadata.}
+  gem.summary       = %q{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      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency 'stanford-mods'
+  
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/spec/configuration/base_spec.rb

@@ -0,0 +1,29 @@
+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
+    config.label_class.should == "testing_label_class"
+    config.value_class.should == "testing_value_class"
+  end
+  describe "link" do
+    it "should return an array with a method name and params" do
+      ModsDisplay::Configuration::Base.new do
+        link :my_url_generating_method, q: '"%value%"'
+      end.link.should == [:my_url_generating_method, {:q => '"%value%"'}]
+    end
+  end
+  describe "delmiter" do
+    it "should override the default delimiter" do
+      ModsDisplay::Configuration::Base.new do
+        delimiter "<br/>"
+      end.delimiter.should == "<br/>"
+    end
+    it "should default to ', '" do
+      ModsDisplay::Configuration::Base.new.delimiter.should == ", "
+    end
+  end
+end

data/spec/fields/abstract_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+def mods_display_abstract(mods_record)
+  ModsDisplay::Abstract.new(mods_record, ModsDisplay::Configuration::Base.new, mock("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 "links" do
+    it "should turn URLs into links" do
+      mods_display_abstract(@link).fields.first.values.first.should match(/\(<a href='http:\/\/library.stanford.edu'>http:\/\/library.stanford.edu<\/a>\)/)
+    end
+    it "should turn email addresses into mailto links" do
+      mods_display_abstract(@email).fields.first.values.first.should match(/<a href='mailto:jdoe@example.com'>jdoe@example.com<\/a>/)
+    end
+  end
+end