mods 0.0.18 → 0.0.19

data/README.rdoc

@@ -38,6 +38,7 @@ TODO: Write usage instructions here
 
 == Releases
 
+* <b>0.0.19</b> term_values and term_value method added to Record object
 * <b>0.0.18</b> <subject><temporal> cannot have subelements
 * <b>0.0.17</b> add display_value and display_value_w_date to name node; add personal_names_w_dates to record
 * <b>0.0.16</b> add role convenience methods (within name node)

data/lib/mods/record.rb

@@ -56,6 +56,88 @@ module Mods
         set_terminology_no_ns(@mods_ng_xml)
       end
     end
+    
+    # get the value for the terms, as a String. f there are multiple values, they will be joined with the separator. 
+    #  If there are no values, the result will be nil.
+    # @param [Symbol or String or Array<Symbol>] messages the single symbol of the message to send to the Stanford::Mods::Record object
+    #  (as a Symbol or a String), or an Array of (Symbols or Strings) to be sent as messages. 
+    #  Messages will usually be terms from the nom-xml terminology defined in the mods gem.)
+    # @param [String] sep - the separator string to insert between multiple values
+    # @return [String] a String representing the value(s) or nil.
+    def term_value messages, sep = ' '
+      case messages
+        when Symbol
+          nodes = send(messages)
+        when String
+          nodes = send(messages.to_sym)
+        when Array
+          obj = self
+          messages.each { |msg|
+            if msg.is_a? Symbol
+              obj = obj.send(msg)
+            elsif msg.is_a? String
+              obj = obj.send(msg.to_sym)
+            else
+              raise ArgumentError, "term_value called with Array containing unrecognized class: #{msg.class}, #{messages.inspect}", caller
+            end
+          }
+          nodes = obj
+        else
+          raise ArgumentError, "term_value called with unrecognized argument class: #{messages.class}", caller
+      end
+
+      val = ''
+      if nodes
+        nodes.each { |n| 
+          val << sep + n.text unless n.text.empty?
+        }
+      end
+      val.sub!(sep, '')
+      return nil if val.empty?
+      val
+    rescue NoMethodError
+      raise ArgumentError, "term_value called with unknown argument: #{messages.inspect}", caller
+    end
+
+    # get the values for the terms, as an Array. If there are no values, the result will be nil.
+    # @param [Symbol or String or Array<Symbol>] messages the single symbol of the message to send to the Stanford::Mods::Record object
+    #  (as a Symbol or a String), or an Array of (Symbols or Strings) to be sent as messages. 
+    #  Messages will usually be terms from the nom-xml terminology defined in the mods gem.)
+    # @return [Array<String>] an Array with a String value for each result node's non-empty text, or nil if none
+    def term_values messages
+      case messages
+        when Symbol
+          nodes = send(messages)
+        when String
+          nodes = send(messages.to_sym)
+        when Array
+          obj = self
+          messages.each { |msg|
+            if msg.is_a? Symbol
+              obj = obj.send(msg)
+            elsif msg.is_a? String
+              obj = obj.send(msg.to_sym)
+            else
+              raise ArgumentError, "term_values called with Array containing unrecognized class: #{msg.class}, #{messages.inspect}", caller
+            end
+          }
+          nodes = obj
+        else
+          raise ArgumentError, "term_values called with unrecognized argument class: #{messages.class}", caller
+      end
+
+      vals = []
+      if nodes
+        nodes.each { |n| 
+          vals << n.text unless n.text.empty?
+        }
+      end
+      return nil if vals.empty?
+      vals
+    rescue NoMethodError
+      raise ArgumentError, "term_values called with unknown argument: #{messages.inspect}", caller
+    end
+    
 
     # @return Array of Strings, each containing the text contents of <mods><titleInfo>   <nonSort> + ' ' + <title> elements
     #  but not including any titleInfo elements with type="alternative"

data/lib/mods/version.rb

@@ -1,4 +1,4 @@
 module Mods
   # this is the Ruby Gem version
-  VERSION = "0.0.18"
+  VERSION = "0.0.19"
 end

data/spec/record_spec.rb

@@ -82,6 +82,84 @@ describe "Mods::Record" do
     end
   end # context from_nk_node
   
+  context "getting term values" do
+    before(:all) do
+      m = "<mods #{@def_ns_decl}>
+        <abstract>single</abstract>
+        <genre></genre>
+        <note>mult1</note>
+        <note>mult2</note>
+        <subject><topic>topic1</topic><topic>topic2</topic></subject>
+        <subject><topic>topic3</topic></subject>
+      </mods>"
+      @mods_rec = Mods::Record.new
+      @mods_rec.from_str(m)
+    end
+    
+    context "term_value (single value result)" do
+      it "should return nil if there are no such values in the MODS" do
+        @mods_rec.term_value(:identifier).should == nil
+      end
+      it "should return nil if there are only empty values in the MODS" do
+        @mods_rec.term_value(:genre).should == nil
+      end
+      it "should return a String for a single value" do
+        @mods_rec.term_value(:abstract).should == 'single'
+      end
+      it "should return a String containing all values, with separator, for multiple values" do
+        @mods_rec.term_value(:note).should == 'mult1 mult2'
+      end
+      it "should work with an Array of messages passed as the argument" do
+        @mods_rec.term_value([:subject, 'topic']).should == 'topic1 topic2 topic3'
+      end
+      it "should work with a String passed as the argument" do
+        @mods_rec.term_value('abstract').should == 'single'
+      end
+      it "should take a separator argument" do
+        @mods_rec.term_value(:note, ' -|-').should == 'mult1 -|-mult2'
+      end
+      it "should raise an error for an unrecognized message symbol" do
+        expect { @mods_rec.term_value(:not_there) }.to raise_error(ArgumentError, "term_value called with unknown argument: :not_there")
+      end
+      it "should raise an error if the argument is an Array containing non-symbols" do
+        expect { @mods_rec.term_value([:subject, @mods_rec.subject]) }.to raise_error(ArgumentError, /term_value called with Array containing unrecognized class:.*NodeSet.*/)
+      end
+      it "should raise an error if the argument isn't a Symbol or an Array" do
+        expect { @mods_rec.term_value(@mods_rec.subject) }.to raise_error(ArgumentError, /term_value called with unrecognized argument class:.*NodeSet.*/)
+      end
+    end
+
+    context "term_values (multiple values)" do
+      it "should return nil if there are no such values in the MODS" do
+        @mods_rec.term_values(:identifier).should == nil
+      end
+      it "should return nil if there are only empty values in the MODS" do
+        @mods_rec.term_values(:genre).should == nil
+      end
+      it "should return an array of size one for a single value" do
+        @mods_rec.term_values(:abstract).should == ['single']
+      end
+      it "should return an array of values for multiple values" do
+        @mods_rec.term_values(:note).should == ['mult1', 'mult2']
+      end
+      it "should work with an Array of messages passed as the argument" do
+        @mods_rec.term_values([:subject, 'topic']).should == ['topic1', 'topic2', 'topic3']
+      end
+      it "should work with a String passed as the argument" do
+        @mods_rec.term_values('abstract').should == ['single']
+      end
+      it "should raise an error for an unrecognized message symbol" do
+        expect { @mods_rec.term_values(:not_there) }.to raise_error(ArgumentError, "term_values called with unknown argument: :not_there")
+      end
+      it "should raise an error if the argument is an Array containing non-symbols" do
+        expect { @mods_rec.term_values([:subject, @mods_rec.subject]) }.to raise_error(ArgumentError, /term_values called with Array containing unrecognized class:.*NodeSet.*/)
+      end
+      it "should raise an error if the argument isn't a Symbol or an Array" do
+        expect { @mods_rec.term_values(@mods_rec.subject) }.to raise_error(ArgumentError, /term_values called with unrecognized argument class:.*NodeSet.*/)
+      end
+    end    
+  end # getting term values
+  
   context "convenience methods for accessing tricky bits of terminology" do
     before(:all) do
       @mods_rec = Mods::Record.new
@@ -254,6 +332,6 @@ describe "Mods::Record" do
         @mods_rec.languages.should include("Dutch; Flemish")
       end
     end
-  end # convenience methods
+  end # convenience methods for tricky bits of terminology
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mods
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
   prerelease: 
 platform: ruby
 authors:
@@ -230,7 +230,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1014279353675064863
+      hash: -103128391758447050
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -239,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1014279353675064863
+      hash: -103128391758447050
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24