mods_display 0.1.4 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8ec2c58c34a3f05225a077459d6cc226cd587a0a
+  data.tar.gz: c0e3f4e6e7533f5b25c0eb735f0bd0f5cfd9ea47
+SHA512:
+  metadata.gz: 567d5eed25681658bf0cd94141d83b846d99b9d6698e20462f52a83a52f833c4e757fdb2da218c1c0decec854bc9b2651d044397685847e8547127afca49d8bb
+  data.tar.gz: f3e05076e40607b5ca914401feb0acce6aacf80ba43361bfbdb05aa535d4372fae6832910c0f805be6b422141d310c17e3e57dba4062afba21c980c3a9a8447e

data/README.md

@@ -144,15 +144,28 @@ Once installed, the class that included the `ControllerExtension` (`MyController
 The basic render call will return the top-level ModsDisplay::HTML class object.  Any String method (e.g. #html_safe) you call on this top-level object will be sent down to the #to_html method which will return the HTML for all the metadata in the MODS document.
 
     render_mods_display(@model).to_html
-    
-You can abstract the main title by calling #title on the top-level HTML method
+
+You can abstract the main (first) title by calling #title on the top-level HTML method
 
     render_mods_display(@model).title
-    
-When getting JUST the main title out of the metadata, it will be useful to get the rest of the metadata without the main title.  You can accomplish this by calling #body on the top-level HTML object.
+
+When getting JUST the main (first) title out of the metadata, it will be useful to get the rest of the metadata without the main title.  You can accomplish this by calling #body on the top-level HTML object.
 
     render_mods_display(@model).body
 
+## Advanced Usage
+
+You can also access the array of ModsDisplay::Values objects for a given class directly by calling the name of the class. The class names are not always intuitive for public consumption so you may want to check the code the particular method to call.
+
+    render_mods_display(@model).abstract
+    => [#<ModsDisplay::Values @label="Abstract", @values=["Hey. I'm an abstract."]>]
+
+Given that this semantics that we're concerned with here are more about titles and data construction rather than XML it may be required that you find something by the label. A common example of this is the imprint class.  The imprint class can retun other publication data that is not the imprint statement.  You'll want to select (using your favorite enumerable method) the element in the array that is an imprint.
+
+    imprint = render_mods_display(@model).imprint.find do |data|
+      data.label == "Imprint"
+    end.values
+
 ## Contributing
 
 1. Fork it

data/lib/mods_display/html.rb

@@ -44,6 +44,8 @@ class ModsDisplay::HTML
   def method_missing(method_name, *args, &block)
     if self.to_s.respond_to?(method_name)
       self.to_html.send(method_name, *args, &block)
+    elsif mods_display_fields.include?(method_name)
+      mods_field(@xml, method_name).fields
     else
       super
     end

data/lib/mods_display/version.rb

@@ -1,3 +1,3 @@
 module ModsDisplay
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/spec/fields/abstract_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_abstract(mods_record)
-  ModsDisplay::Abstract.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Abstract.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Abstract do

data/spec/fields/access_condition_spec.rb

@@ -1,13 +1,13 @@
 require "spec_helper"
 
 def mods_display_access_condition(mods_record)
-  ModsDisplay::AccessCondition.new(mods_record, ModsDisplay::Configuration::AccessCondition.new, mock("controller"))
+  ModsDisplay::AccessCondition.new(mods_record, ModsDisplay::Configuration::AccessCondition.new, double("controller"))
 end
 def mods_display_versioned_access_condition(mods_record, version)
-  ModsDisplay::AccessCondition.new(mods_record, ModsDisplay::Configuration::AccessCondition.new{cc_license_version version}, mock("controller"))
+  ModsDisplay::AccessCondition.new(mods_record, ModsDisplay::Configuration::AccessCondition.new{cc_license_version version}, double("controller"))
 end
 def mods_display_non_ignore_access_condition(mods_record)
-  ModsDisplay::AccessCondition.new(mods_record, ModsDisplay::Configuration::AccessCondition.new{display!}, mock("controller"))
+  ModsDisplay::AccessCondition.new(mods_record, ModsDisplay::Configuration::AccessCondition.new{display!}, double("controller"))
 end
 
 describe ModsDisplay::AccessCondition do

data/spec/fields/audience_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_audience(mods_record)
-  ModsDisplay::Audience.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Audience.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Contents do

data/spec/fields/cartographics_spec.rb

@@ -3,7 +3,7 @@ require "fixtures/cartographics_fixtures"
 include CartographicsFixtures
 
 def mods_display_cartographics(mods)
-  ModsDisplay::Cartographics.new(mods, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Cartographics.new(mods, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Cartographics do

data/spec/fields/collection_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_collection(mods_record)
-  ModsDisplay::Collection.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Collection.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Collection do

data/spec/fields/contact_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_contact(mods_record)
-  ModsDisplay::Contact.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Contact.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Contact do

data/spec/fields/contents_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_contents(mods_record)
-  ModsDisplay::Contents.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Contents.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Contents do

data/spec/fields/description_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_description(mods)
-  ModsDisplay::Description.new(mods, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Description.new(mods, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Description do

data/spec/fields/format_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 def mods_display_format(mods)
-  ModsDisplay::Format.new(mods, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Format.new(mods, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Format do

data/spec/fields/genre_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_genre(mods_record)
-  ModsDisplay::Genre.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Genre.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Abstract do

data/spec/fields/identifier_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_id(mods_record)
-  ModsDisplay::Identifier.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Identifier.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Note do

data/spec/fields/imprint_spec.rb

@@ -4,10 +4,10 @@ require "fixtures/imprint_fixtures"
 include ImprintFixtures
 
 def mods_display_imprint(mods_record)
-  ModsDisplay::Imprint.new(mods_record, ModsDisplay::Configuration::Imprint.new, mock("controller"))
+  ModsDisplay::Imprint.new(mods_record, ModsDisplay::Configuration::Imprint.new, double("controller"))
 end
 def mods_display_format_date_imprint(mods_record)
-  ModsDisplay::Imprint.new(mods_record, ModsDisplay::Configuration::Imprint.new{full_date_format "(%Y) %B, %d"; short_date_format "%B (%Y)"}, mock("controller"))
+  ModsDisplay::Imprint.new(mods_record, ModsDisplay::Configuration::Imprint.new{full_date_format "(%Y) %B, %d"; short_date_format "%B (%Y)"}, double("controller"))
 end
 
 describe ModsDisplay::Imprint do

data/spec/fields/language_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_language(mods_record)
-  ModsDisplay::Language.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Language.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Language do

data/spec/fields/location_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_location(mods_record)
-  ModsDisplay::Location.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Location.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Note do

data/spec/fields/name_spec.rb

@@ -10,7 +10,7 @@ def mods_display_name_link(mods_record)
 end
 
 def mods_display_name(mods_record)
-  ModsDisplay::Name.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Name.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Language do

data/spec/fields/note_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_note(mods_record)
-  ModsDisplay::Note.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Note.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Note do

data/spec/fields/related_item_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_item(mods_record)
-  ModsDisplay::RelatedItem.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::RelatedItem.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::RelatedItem do

data/spec/fields/resource_type_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_resource_type(mods_record)
-  ModsDisplay::ResourceType.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::ResourceType.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::ResourceType do

data/spec/fields/sub_title_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_sub_title(mods_record)
-  ModsDisplay::SubTitle.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::SubTitle.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::SubTitle do

data/spec/fields/title_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 def mods_display_title(mods_record)
-  ModsDisplay::Title.new(mods_record, ModsDisplay::Configuration::Base.new, mock("controller"))
+  ModsDisplay::Title.new(mods_record, ModsDisplay::Configuration::Base.new, double("controller"))
 end
 
 describe ModsDisplay::Title do

data/spec/integration/html_spec.rb

@@ -9,6 +9,7 @@ end
 describe "HTML Output" do
   before(:all) do
     @multiple_titles = html_from_mods("<mods><titleInfo><title>Main Title</title></titleInfo><titleInfo type='alternative'><title>Alternate Title</title></titleInfo></mods>")
+    @abstract = html_from_mods("<mods><abstract>Hey. I'm an abstract.</abstract></mods>")
   end
   
   describe "titles" do
@@ -24,4 +25,20 @@ describe "HTML Output" do
       @multiple_titles.body.should     include("<dd>Alternate Title</dd>")
     end
   end
+  describe "individual fields" do
+    it "should return ModsDispaly::Values for the specefied field" do
+      fields = @abstract.abstract
+      fields.each do |field|
+        field.should be_a ModsDisplay::Values
+      end
+      fields.length.should eq 1
+      fields.first.values.should eq ["Hey. I'm an abstract."]
+    end
+    it "should return a blank array if no data is available for a specific field" do
+      @abstract.genre.should eq []
+    end
+    it "should not return a field that doesn't exist (and isn't a string)" do
+      -> {@abstract.not_a_real_field}.should raise_error NoMethodError
+    end
+  end
 end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: mods_display
 version: !ruby/object:Gem::Version
-  version: 0.1.4
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Jessie Keck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-13 00:00:00.000000000 Z
+date: 2013-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stanford-mods
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: MODS Display is a gem to centralize the display logic of MODS medadata.
@@ -146,33 +139,26 @@ files:
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 841363986478259673
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 841363986478259673
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+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.