mods_display 0.0.1.beta1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+notifications:
+  email: false
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mods_display.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,26 @@
+Copyright (c) 2012-2013.  The Board of Trustees of the Leland Stanford Junior University. All rights reserved.
+
+Redistribution and use of this distribution in source and binary forms, with or without modification, are permitted provided that: The above copyright notice and this permission notice appear in all copies and supporting documentation; The name, identifiers, and trademarks of The Board of Trustees of the Leland Stanford Junior University are not used in advertising or publicity without the express prior written permission of The Board of Trustees of the Leland Stanford Junior University; Recipients acknowledge that this distribution is made available as a research courtesy, "as is", potentially with defects, without any obligation on the part of The Board of Trustees of the Leland Stanford Junior University to provide support, services, or repair;
+
+THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND IN NO EVENT SHALL THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, TORT (INCLUDING NEGLIGENCE) OR STRICT LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,136 @@
+[![Build Status](https://travis-ci.org/sul-dlss/mods_display.png?branch=master)](https://travis-ci.org/sul-dlss/mods_display)
+
+# ModsDisplay
+
+A gem for displaying MODS Metadata in a configurable way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mods_display'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mods_display
+    
+Include the `ModelExtension` into your model.
+
+    class MyClass
+      include ModsDisplay::ModelExtension
+    end
+
+Configure the source of the MODS xml string
+
+    class MyClass
+      ....
+      
+      mods_xml_source do |model|
+        model.mods
+      end
+      
+    end
+
+Include the `ControllerExtension` into your rails controller (or another class if not using rails).
+
+    class MyController
+      include ModsDisplay::ControllerExtension
+    end
+    
+Optionally configure the mods display gem (more on configuration later).
+
+    class MyController
+      ....
+      configure_mods_display do
+        ....
+      end
+    end
+
+## Configuration
+
+In the class that you include the `ModsDisplay::ControllerExtension` you can configure various behavior for different fields.  The configuration options provided by `ModsDisplay::Configuration::Base` are:
+
+* label_class
+* value_class
+* delimiter
+* link
+
+### Label and Value classes
+
+Both label_ and value_class accept strings to put in as a class.
+
+    class MyController
+      include ModsDisplay::ControllerExtension
+      
+      configure_mods_display do
+        title do
+          label_class "title-label"
+          value_class "title-value"
+        end
+      end
+    end
+
+### Delimiter
+
+The delimiter configuration option accepts a string which will be used to delimit multiple multiple values within a single label.
+
+    configure_mods_display do
+      note do
+        delimiter "<br/>"
+      end
+    end
+
+Note: The default is a comma and a space (", ")
+
+### Link
+
+The link configuration option takes 2 parameters. The first is a key that is a method_name available in the class including `ModsDisplay::ControllerExtension` and the 2nd is options to pass to that method.  This method must return a string that will be used as the href attribute of the link. (NOTE: If you have the %value% token in your options that will be replaced with the value of the field being linked)
+
+    class MyController
+      include ModsDisplay::ControllerExtension
+      
+      configure_mods_display do
+        format do
+          link :format_path, '"%value%"'
+        end
+      end
+      
+      def format_path(format)
+        "http://example.com/?f[format_field][]=#{format}"
+      end
+    end
+
+### Special Subject Configuration
+
+Depending on the implementation of subjects there may be different ways you would want to link them.  The standard way of linking will just create a link passing the value to the href and the link text.  However; in certain cases the subjects should be linked so that each subject to the right of a delimiter should have the values of all its preceding values in the href.
+
+[Country](http://example.com/?"Country") > [State](http://example.com/?"Country State") > [City](http://example.com/?"Country State City")
+    
+This can be accomplished by setting the hierarchical_link configuration option to true for subjects
+
+    configure_mods_display do
+      subject do
+        hierarchical_link true
+      end
+    end
+
+NOTE: The default delimiter is set to > for subjects.
+
+## Usage
+
+Once installed, the class that included the `ControllerExtension` (`MyController`) will have the `render_mods_display` method available.  This method takes one argument which is an instance of the class that included the `ModelExtension` (`MyClass`).
+
+    render_mods_display(@model) # where @model.is_a?(MyClass)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/mods_display.rb

@@ -0,0 +1,30 @@
+require "mods_display/controller_extension"
+require "mods_display/html"
+require "mods_display/model_extension"
+require "mods_display/configuration"
+require "mods_display/configuration/base"
+require "mods_display/configuration/subject"
+require "mods_display/fields/field"
+require "mods_display/fields/abstract"
+require "mods_display/fields/audience"
+require "mods_display/fields/collection"
+require "mods_display/fields/contents"
+require "mods_display/fields/cartographics"
+require "mods_display/fields/description"
+require "mods_display/fields/format"
+require "mods_display/fields/identifier"
+require "mods_display/fields/imprint"
+require "mods_display/fields/language"
+require "mods_display/fields/location"
+require "mods_display/fields/name"
+require "mods_display/fields/note"
+require "mods_display/fields/related_item"
+require "mods_display/fields/related_location"
+require "mods_display/fields/subject"
+require "mods_display/fields/title"
+require "mods_display/fields/values"
+require "mods_display/version"
+
+module ModsDisplay
+
+end

data/lib/mods_display/configuration.rb

@@ -0,0 +1,73 @@
+class ModsDisplay::Configuration
+  def initialize &config
+    instance_eval &config
+  end
+
+  def title &title
+    @title ||= ModsDisplay::Configuration::Base.new(&title || Proc.new{})
+  end
+
+  def name &name
+    @name ||= ModsDisplay::Configuration::Base.new(&name || Proc.new{})
+  end
+
+  def format &format
+    @format ||= ModsDisplay::Configuration::Base.new(&format || Proc.new{})
+  end
+
+  def imprint &imprint
+    @imprint ||= ModsDisplay::Configuration::Base.new(&imprint || Proc.new{})
+  end
+
+  def language &language
+    @language ||= ModsDisplay::Configuration::Base.new(&language || Proc.new{})
+  end
+
+  def description &description
+    @description ||= ModsDisplay::Configuration::Base.new(&description || Proc.new{})
+  end
+
+  def cartographics &cartographics
+    @cartographics ||= ModsDisplay::Configuration::Base.new(&cartographics || Proc.new{})
+  end
+
+  def abstract &abstract
+    @abstract ||= ModsDisplay::Configuration::Base.new(&abstract || Proc.new{})
+  end
+
+  def contents &contents
+    @contents ||= ModsDisplay::Configuration::Base.new(&contents || Proc.new{})
+  end
+
+  def audience &audience
+    @audience ||= ModsDisplay::Configuration::Base.new(&audience || Proc.new{})
+  end
+
+  def note &note
+    @note ||= ModsDisplay::Configuration::Base.new(&note || Proc.new{})
+  end
+
+  def collection &collection
+    @collection ||= ModsDisplay::Configuration::Base.new(&collection || Proc.new{})
+  end
+
+  def related_location &related_location
+    @related_location ||= ModsDisplay::Configuration::Base.new(&related_location || Proc.new{})
+  end
+
+  def related_item &related_item
+    @related_item ||= ModsDisplay::Configuration::Base.new(&related_item || Proc.new{})
+  end
+
+  def subject &subject
+    @subject ||= ModsDisplay::Configuration::Subject.new(&subject || Proc.new{})
+  end
+
+  def identifier &identifier
+    @identifier ||= ModsDisplay::Configuration::Base.new(&identifier || Proc.new{})
+  end
+
+  def location &location
+    @location ||= ModsDisplay::Configuration::Base.new(&location || Proc.new{})
+  end
+end

data/lib/mods_display/configuration/base.rb

@@ -0,0 +1,23 @@
+class ModsDisplay::Configuration::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
+
+end

data/lib/mods_display/configuration/subject.rb

@@ -0,0 +1,11 @@
+class ModsDisplay::Configuration::Subject < ModsDisplay::Configuration::Base
+
+  def hierarchical_link hierarchical_link=false
+    @hierarchical_link ||= hierarchical_link
+  end
+
+  def delimiter delimiter=" &gt; "
+    @delimiter ||= delimiter
+  end
+
+end

data/lib/mods_display/controller_extension.rb

@@ -0,0 +1,32 @@
+module ModsDisplay::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 
+    end
+  end
+
+end

data/lib/mods_display/fields/abstract.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+class ModsDisplay::Abstract < ModsDisplay::Field
+
+  def label
+    super || "Abstract"
+  end
+
+  def text
+    return link_value(super) unless super.nil?
+    link_value(@value.text)
+  end
+
+  private
+
+  def link_value(val)
+    val = val.dup
+    # http://daringfireball.net/2010/07/improved_regex_for_matching_urls
+    url = /(?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 = /[A-Z0-9_\.%\+\-\']+@(?:[A-Z0-9\-]+\.)+(?:[A-Z]{2,4}|museum|travel)/i
+    matches = [val.scan(url), val.scan(email)].flatten
+    matches.each do |match|
+      if match =~ email
+        val = val.gsub(match, "<a href='mailto:#{match}'>#{match}</a>")
+      else
+        val = val.gsub(match, "<a href='#{match}'>#{match}</a>")
+      end
+    end
+    val
+  end
+
+end

data/lib/mods_display/fields/audience.rb

@@ -0,0 +1,7 @@
+class ModsDisplay::Audience < ModsDisplay::Field
+
+  def label
+    super || "Target audience"
+  end
+
+end

data/lib/mods_display/fields/cartographics.rb

@@ -0,0 +1,21 @@
+class ModsDisplay::Cartographics < ModsDisplay::Field
+
+  def fields
+    return nil if @value.nil?
+    return_values = []
+    @value.each do |val|
+      if val.respond_to?(:cartographics)
+        val.cartographics.each do |field|
+          scale = field.scale.empty? ? "Scale not given" : field.scale.text
+          projection = field.projection.empty? ? nil : field.projection.text
+          coordinates = field.coordinates.empty? ? nil : field.coordinates.text
+          post_scale = [projection, coordinates].compact.length > 0 ? [projection, coordinates].compact.join(" ") : nil
+          return_values << ModsDisplay::Values.new({:label => (displayLabel(field) || label || "Map Data"),
+                                                    :values => [[scale, post_scale].compact.join(" ; ")]})
+        end
+      end
+    end
+    return_values
+  end
+
+end

data/lib/mods_display/fields/collection.rb

@@ -0,0 +1,21 @@
+class ModsDisplay::Collection < ModsDisplay::Field
+
+  def label
+    super || "Collection"
+  end
+
+  def fields
+    return_values = []
+    @value.each do |val|
+      if val.respond_to?(:titleInfo) and
+         val.respond_to?(:typeOfResource) and
+         val.typeOfResource.attributes.length > 0 and
+         val.typeOfResource.attributes.first.has_key?("collection") and
+         val.typeOfResource.attributes.first["collection"].value == "yes"
+        return_values << ModsDisplay::Values.new(:label => label, :values => [val.titleInfo.text.strip])
+      end
+    end
+    return_values
+  end
+
+end