anvl 0.2.1 → 0.3.0

data/.gitignore

@@ -0,0 +1,42 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/Gemfile

@@ -1,13 +1,4 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.1"
-  gem "rcov", ">= 0"
-end
+# Specify your gem's dependencies in test.gemspec
+gemspec

data/Gemfile.lock

@@ -1,20 +1,31 @@
+PATH
+  remote: .
+  specs:
+    anvl (0.3.0)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    git (1.2.5)
-    jeweler (1.5.1)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
+    diff-lcs (1.1.2)
     rake (0.8.7)
     rcov (0.9.9)
-    shoulda (2.11.3)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    yard (0.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.1)
+  anvl!
+  bundler
+  rake
   rcov
-  shoulda
+  rspec
+  yard

data/LICENSE.txt

@@ -1,20 +1,13 @@
-Copyright (c) 2010 Chris Beer
+Copyright (c) 2011 Chris Beer
 
-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:
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+    http://www.apache.org/licenses/LICENSE-2.0
 
-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.
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/{README.rdoc → README.textile}

@@ -1,8 +1,8 @@
-= anvl
+# anvl
 
-Ruby implementation of A Name-Value Language (ANVL)
+This is a Ruby implementation of the [A Name-Value Language (ANVL)](https://wiki.ucop.edu/display/Curation/Anvl) microservice. ANVL (A Name-Value Language) is a simple record syntax based on email headers. An ANVL record is a sequence of data elements ending in a blank line. An element consists of a label, a colon, and an optional value, and a long value may be folded (continued) onto the next line by inserting a newline and indenting the next line.
 
-== Contributing to anvl
+## Contributing to anvl
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -12,8 +12,8 @@ Ruby implementation of A Name-Value Language (ANVL)
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+## Copyright
 
-Copyright (c) 2010 Chris Beer. See LICENSE.txt for
+Copyright (c) 2011 Chris Beer. See LICENSE.txt for
 further details.
 

data/Rakefile

@@ -8,45 +8,41 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
+require 'rspec'
+require 'rspec/core/rake_task'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "anvl"
-  gem.homepage = "http://github.com/cbeer/anvl"
-  gem.license = "MIT"
-  gem.summary = %Q{Ruby implementation of A Name-Value Language (ANVL)}
-  gem.email = "chris@cbeer.info"
-  gem.authors = ["Chris Beer"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+RSpec::Core::RakeTask.new() do |t|
+  t.pattern = "./spec/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec', '--exclude', 'gems']
 end
-Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec', '--exclude', 'gems']
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
+task :default => :rcov
+task :hudson => [:rcov, :doc]
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+# Use yard to build docs
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  project_root = File.expand_path(File.dirname(__FILE__))
+  doc_destination = File.join(project_root, 'doc')
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "anvl #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  YARD::Rake::YardocTask.new(:doc) do |yt|
+    yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) + 
+                 [ File.join(project_root, 'README.textile') ]
+    yt.options = ['--output-dir', doc_destination, '--readme', 'README.textile']
+  end
+rescue LoadError
+  desc "Generate YARD Documentation"
+  task :doc do
+    abort "Please install the YARD gem to generate rdoc."
+  end
 end
+

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/anvl.gemspec

@@ -1,70 +1,30 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{anvl}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
+  s.description = "Ruby ANVL implementation"
+  s.summary = "Ruby ANVL implementation"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Beer"]
-  s.date = %q{2010-12-15}
+  s.date = %q{2011-06-12}
   s.email = %q{chris@cbeer.info}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "anvl.gemspec",
-    "lib/anvl.rb",
-    "lib/anvl/document.rb",
-    "lib/anvl/element.rb",
-    "lib/anvl/erc.rb",
-    "test/helper.rb",
-    "test/test_anvl.rb",
-    "test/test_element.rb",
-    "test/test_erc.rb"
-  ]
-  s.homepage = %q{http://github.com/cbeer/anvl}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Ruby implementation of A Name-Value Language (ANVL)}
-  s.test_files = [
-    "test/helper.rb",
-    "test/test_anvl.rb",
-    "test/test_element.rb",
-    "test/test_erc.rb"
+    "README.textile"
   ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-    else
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-  end
+  # Bundler will install these gems too if you've checked this out from source from git and run 'bundle install'
+  s.add_development_dependency "rake"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency 'rcov'
+  s.add_development_dependency 'yard'
 end
 

data/lib/anvl.rb

@@ -1,10 +1,12 @@
 require 'anvl/element'
 require 'anvl/document'
 module ANVL
+  # Parse an ANVL document into a hash
   def self.parse *args
     Document.parse *args
   end
 
+  # Serialize a Hash to an ANVL string
   def self.to_anvl *args
     anvl = Document.parse *args
     anvl.to_s

data/lib/anvl/document.rb

@@ -1,21 +1,25 @@
 module ANVL
   class Document # < Hash
+    # Parse an ANVL formatted string into an ANVL::Document
+    # @param String
     def self.parse str
       anvl = self.new  str
       anvl
     end
 
+    # ANVL key/value pairs
     attr_reader :entries
 
-    def initialize obj = nil
+    # @param [String, Hash] obj optional ANVL formatted string or hash values 
+    def initialize anvl_string_or_hash = nil
       @entries = Array.new
 
-      case obj
+      case anvl_string_or_Hash
         when Hash
-          self.push obj
+          self.push anvl_string_or_hash
 
 	when String
-	  lines = obj.gsub(/\s?\n\s+/, ' ').split("\n")
+	  lines = anvl_string_or_hash.gsub(/\s?\n\s+/, ' ').split("\n")
 
 	  lines.each_with_index do |str, i|
 	    case str
@@ -28,13 +32,14 @@ module ANVL
 	    end  
 	  end  
 
-      end if obj
+      end if anvl_string_or_hash
 
       add_entries_methods
 
       gc!
     end
 
+    # @return [String] an ANVL-formatted string
     def to_s
       gc!
       @entries.map do |obj|
@@ -42,6 +47,7 @@ module ANVL
       end.join "\n"
     end
 
+    # @return [Hash] an ordinary hash representation of the ANVL document
     def to_h
       gc!
       h = {}
@@ -58,6 +64,11 @@ module ANVL
       h
     end
 
+    # Retrieve an ANVL entry
+    # @param [String] display_label
+    # @param [Hash] args
+    # @option args [Boolean] :raw 
+    # @return [Array, String]
     def [] display_label, args = {}
       v = @entries.select { |x| x =~ display_label }
       v &&= v.map { |x| x.to_s } unless args[:raw]
@@ -66,6 +77,10 @@ module ANVL
     end
     alias_method :fetch, :[]
 
+    # Set an ANVL key/value pair
+    # @param [String] display_label
+    # @param [String] value
+    # @param [Boolean] append (if false (the default), it will overwrite any existing tags for the label)
     def []= display_label, value, append = false
       label = convert_label display_label
       value = [value] unless value.is_a? Array
@@ -79,9 +94,10 @@ module ANVL
         end
       end
     end
-
     alias_method :store, :[]=
 
+    # Append an ANVL key/value pair to the document
+    # @param [Hash]  key => value to append
     def push hash
       hash.each do |label, value|
         self.store label, value, true

data/lib/anvl/version.rb

@@ -0,0 +1,10 @@
+module ANVL
+  unless ANVL.const_defined? :VERSION
+    def self.version
+      @version ||= File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')).chomp
+    end
+
+    VERSION = self.version
+  end
+end
+

data/spec/anvl_spec.rb

@@ -0,0 +1,110 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ANVL" do
+  describe "parsing tests" do
+    it "should parse empty files" do
+      anvl = ANVL.parse('')
+      anvl.entries.should have(0).items
+    end
+
+    it "should ignore comment lines" do
+      anvl = ANVL.parse("#")
+      anvl.entries.should have(0).items
+    end
+
+    it "should handle multiple values" do
+      anvl = ANVL.parse "entry:
+a: 1
+a: 2"
+
+      anvl[:a].should == ["1","2"]
+    end
+
+    it "should suport string or key access" do
+      str = 'erc:
+who:    Lederberg, Joshua
+what:   Studies of Human Families for Genetic Linkage
+when:   1974
+where:  http://profiles.nlm.nih.gov/BB/AA/TT/tt.pdf
+note:   This is an arbitrary note inside a
+        small descriptive record.'
+      anvl = ANVL::Document.parse str
+      anvl['who'].should == anvl[:who]
+
+
+    end
+
+
+    it "should parse a complete document" do
+      anvl = ANVL.parse <<-eos
+entry: 
+# first draft 
+who: Gilbert, W.S. | Sullivan, Arthur 
+what: The Yeomen of
+      the Guard 
+when/created: 1888
+eos
+      anvl[:entry].should == ""
+      anvl[:who].should == "Gilbert, W.S. | Sullivan, Arthur"
+      anvl[:what].should == "The Yeomen of the Guard"
+      anvl[:"when/created"].should == "1888"
+
+    end
+  end
+
+  describe "serializing test" do
+    it "should output an empty document" do
+      str = ANVL.to_anvl({})
+      str.should == ""
+    end
+
+    it "should handle new lines by indenting appropriately" do
+      str = ANVL.to_anvl({:with_newline => "abc\n123"})
+      str.should == "with_newline: abc\n    123"
+    end
+
+    it "should support label aliases" do
+      str = ANVL.to_anvl(:a => {:display_label => 'A', :value => '123'})
+      str.should match(/A: 123/)
+    end
+
+    it "should serialize a complete document" do
+      str = ANVL.to_anvl({:entry => [""], :who => ['Gilbert, W.S. | Sullivan, Arthur'], :what => ["The Yeomen of the Guard"], :"when/created" => [1888]})
+
+      arr = str.split("\n")
+      
+      arr.should include("who: Gilbert, W.S. | Sullivan, Arthur", "what: The Yeomen of the Guard", "when/created: 1888")
+
+    end
+
+    it "should support iteratively building a document" do
+      anvl = ANVL::Document.new
+      anvl[:a].should == []
+
+      anvl[:a] = 'a'
+      anvl.to_h.should == {:a => 'a'}
+
+      anvl[:a] = ['a', 'b']
+      anvl.to_h.should == {:a => ['a', 'b']}
+
+      anvl.store :a, 'c', true
+      anvl.to_h.should == {:a => ['a', 'b', 'c']}
+
+      anvl << { :a => 'd' }
+      anvl.to_h.should == {:a => ['a', 'b', 'c', 'd']}
+
+      anvl[:b]
+      anvl.to_h[:b].should be_nil
+
+      anvl << { :c => 1 }
+      anvl[:c].should == "1"
+
+      anvl << { :c => 2 }
+      anvl[:c].should == ["1", "2"]
+
+      arr = anvl.to_s.split("\n")
+      arr.should include("a: a", "a: b", "a: c", "a: d", "c: 1", "c: 2")
+    end
+  end
+end
+

data/spec/element_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'anvl/erc'
+
+describe "ERC element" do
+  it "should handle basic mapping" do
+    h = ANVL::Erc::Element.new :label => 'abc', :value => '123'
+    h.to_s.should == "123"
+    h.to_anvl.should == "abc: 123"
+  end
+
+  it "should support an initial comment to record natural word order" do
+    h = ANVL::Erc::Element.new :label => 'abc', :value => ',  van Gogh, Vincent'
+    h.to_s.should == "Vincent van Gogh"
+    h.to_anvl.should == "abc:,  van Gogh, Vincent"
+
+    h = ANVL::Erc::Element.new :label => 'abc', :value => ',  Howell, III, PhD, 1922-1987, Thurston'
+    h.to_s.should == "Thurston Howell, III, PhD, 1922-1987"
+    h.to_anvl.should == "abc:,  Howell, III, PhD, 1922-1987, Thurston"
+
+    h = ANVL::Erc::Element.new :label => 'abc', :value => ',  McCartney, Paul, Sir,'
+    h.to_s.should == "Sir Paul McCartney"
+    h.to_anvl.should == "abc:,  McCartney, Paul, Sir,"
+  end
+end

data/spec/erc_spec.rb

@@ -0,0 +1,136 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'anvl/erc'
+
+describe "test ERC record handling" do
+  it "should handle empty files" do
+    ANVL::Erc.parse('').entries.should have(0).items
+  end
+
+  it "should handle basic ERC record" do
+    str = 'erc:
+who:    Gibbon, Edward
+what:   The Decline and Fall of the Roman Empire
+when:   1781
+where:  http://www.ccel.org/g/gibbon/decline/'
+
+    erc = ANVL::Erc.parse str
+
+    erc[:erc].should == ""
+    erc[:who].should == "Gibbon, Edward"
+    erc[:what].should == "The Decline and Fall of the Roman Empire"
+    erc[:when].should == "1781"
+    erc[:where].should == "http://www.ccel.org/g/gibbon/decline/"
+  end
+
+  it "should support label structure agnostic key access" do
+    str = 'erc:'
+    erc = ANVL::Erc.parse str
+
+    erc['marc_856'] = 'abc'
+    erc['MARC 856'].should == 'abc'
+
+    erc['MARC 856'] = '123'
+    erc['marc_856'].should == '123'
+
+  end
+
+  it "should support internationalized key access" do
+    str = 'erc:
+who:    Lederberg, Joshua
+h2:   Studies of Human Families for Genetic Linkage'
+    erc = ANVL::Erc.parse str
+
+    erc[:who].should == erc['who']
+    erc[:who].should == erc[:h1]
+    erc[:who].should == erc['wer(h1)']
+
+    erc[:h2].should == erc[:what]
+    erc[:h2].should == erc['was(h2)']
+
+  end
+
+  it "should handle multiple values delimited by a semi-colon" do
+    str = 'erc:
+who:  Smith, J; Wong, D; Khan, H'
+    erc = ANVL::Erc.parse str
+
+    erc[:who].should include("Smith, J", "Wong, D", "Khan, H")
+  end
+
+  it "should handle value normaliation" do
+    str = 'erc:
+who:,  van Gogh, Vincent
+who:,  Howell, III, PhD, 1922-1987, Thurston
+who:,  Acme Rocket Factory, Inc., The
+who:,  Mao Tse Tung
+who:,  McCartney, Pat, Ms,
+who:,  McCartney, Paul, Sir,
+who:,  McCartney, Petra, Dr,
+what:, Health and Human Services, United States Government
+    Department of, The,'
+
+    erc = ANVL::Erc.parse str
+
+    erc[:who].should include("Vincent van Gogh", "Thurston Howell, III, PhD, 1922-1987", "The Acme Rocket Factory, Inc.", "Mao Tse Tung", "Ms Pat McCartney", "Sir Paul McCartney", "Dr Petra McCartney")
+    erc[:what].should == "The United States Government Department of Health and Human Services"
+
+  end
+  
+  it "should unescape value encoding" do
+    str = 'erc:
+who: %sp%ex%dq'
+    h = ANVL::Erc.parse str
+    h[:who].should == ' !"'
+  end
+
+  it "should test for completeness" do
+    str = 'erc:
+what:    The Digital Dilemma
+where:  http://books.nap.edu/html/digital%5Fdilemma
+    '
+
+    erc = ANVL::Erc.parse str
+    erc.should_not be_complete
+
+    erc[:who] = '---'
+    erc[:when] = '---'
+    erc.should be_complete
+
+  end
+
+  describe "abbreviated view" do
+    it "should parse to full document" do
+      str = 'erc: Gibbon, Edward | The Decline and Fall of the Roman Empire
+         | 1781 | http://www.ccel.org/g/gibbon/decline/'
+      erc = ANVL::Erc.parse str
+       
+      erc[:erc].should be_empty
+      erc[:who].should == "Gibbon, Edward"
+      erc[:what].should == "The Decline and Fall of the Roman Empire"
+      erc[:when].should == "1781"
+      erc[:where].should == "http://www.ccel.org/g/gibbon/decline/"
+
+    end
+
+  end
+
+  describe "meta erc document" do
+    it "may be considered complete" do
+      str = 'meta-erc:  NLM | pm9546494 | 19980418
+               | http://ark.nlm.nih.gov/12025/pm9546494??'
+      erc = ANVL::Erc.parse str
+      erc.should be_complete
+
+    end
+  end
+  
+  describe "about erc document" do
+    it "should handle missing values" do
+      str = 'about-erc:   | Bispectrum ; Nonlinearity ; Epilepsy
+                   ; Cooperativity ; Subdural ; Hippocampus'
+      erc = ANVL::Erc.parse str
+      erc['about-what'].should include("Bispectrum", "Nonlinearity", "Epilepsy", "Cooperativity", "Subdural", "Hippocampus")
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'anvl'

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: anvl
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Chris Beer
@@ -14,66 +15,80 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-15 00:00:00 -05:00
+date: 2011-06-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: rake
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: bundler
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
-        - 1
-        - 0
         - 0
-        version: 1.0.0
+        version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: rspec
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rcov
+  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
-  prerelease: false
   version_requirements: *id004
-description: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Ruby ANVL implementation
 email: chris@cbeer.info
 executables: []
 
@@ -81,13 +96,14 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
+- README.textile
 files: 
 - .document
+- .gitignore
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - anvl.gemspec
@@ -95,14 +111,15 @@ files:
 - lib/anvl/document.rb
 - lib/anvl/element.rb
 - lib/anvl/erc.rb
-- test/helper.rb
-- test/test_anvl.rb
-- test/test_element.rb
-- test/test_erc.rb
+- lib/anvl/version.rb
+- spec/anvl_spec.rb
+- spec/element_spec.rb
+- spec/erc_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/cbeer/anvl
-licenses: 
-- MIT
+homepage: 
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -113,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2561876318649041604
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -122,18 +139,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
-summary: Ruby implementation of A Name-Value Language (ANVL)
+summary: Ruby ANVL implementation
 test_files: 
-- test/helper.rb
-- test/test_anvl.rb
-- test/test_element.rb
-- test/test_erc.rb
+- spec/anvl_spec.rb
+- spec/element_spec.rb
+- spec/erc_spec.rb
+- spec/spec_helper.rb

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'anvl'
-
-class Test::Unit::TestCase
-end

data/test/test_anvl.rb

@@ -1,109 +0,0 @@
-require 'helper'
-
-class TestAnvl < Test::Unit::TestCase
-  def test_parse_empty
-    h = ANVL.parse ''
-    assert_equal(0, h.entries.length)
-  end
-
-  def test_parse_comment
-    h = ANVL.parse '#'
-    assert_equal(0, h.entries.length)
-  end
-
-  def test_first_draft
-    h = ANVL.parse 'entry: 
-# first draft 
-who: Gilbert, W.S. | Sullivan, Arthur 
-what: The Yeomen of
-      the Guard 
-when/created: 1888'
-    assert_equal("", h[:entry])
-    assert_equal('Gilbert, W.S. | Sullivan, Arthur', h[:who])
-    assert_equal("The Yeomen of the Guard", h[:what])
-    assert_equal("1888", h[:"when/created"])
-  end
-
-  def test_multiple_values
-    h = ANVL::Document.parse 'entry:
-a: 1
-a: 2'
-    assert_equal({:a => ["1","2"], :entry => ""}, h.to_h)
-  end
-
-  def test_key_access
-    h = ANVL::Document.new
-    assert_equal([], h[:a])
-    h[:a] = 'a'
-    assert_equal({:a => 'a' }, h.to_h)
-    h[:a] = ['a', 'b']
-    assert_equal({:a => ['a', 'b'] }, h.to_h)
-    h[:a].inspect
-    h.store :a, 'c', true
-    assert_equal({:a => ['a', 'b', 'c'] }, h.to_h)
-    assert_equal(['a', 'b', 'c'], h[:a])
-
-    h[:b]
-    assert_equal({:a => ['a', 'b', 'c'] }, h.to_h)
-
-    h << { :a => 'd' }
-    assert_equal({:a => ['a', 'b', 'c', 'd'] }, h.to_h)
-
-    h << { :c => 1 }
-    assert_equal("1", h[:c])
-
-    h << { :c => 2 }
-    assert_equal(["1", "2"], h[:c])
-
-    str = h.to_s
-    assert_match(/^a: a$/, str)
-    assert_match(/^a: b$/, str)
-    assert_match(/^a: c$/, str)
-    assert_match(/^a: d$/, str)
-    assert_match(/^c: 1$/, str)
-    assert_match(/^c: 2$/, str)
-  end
-
-  def test_newlines
-    h = ANVL::Document.new
-    h[:nl] = "abc\n123"
-    assert_equal("nl: abc\n    123", h.to_s)
-  end
-
-  def test_fmt_empty
-    str = ANVL.to_anvl({})
-    assert_equal('', str)
-  end
-  
-  def test_fmt_first_draft
-    str = ANVL.to_anvl({:entry => [""], :who => ['Gilbert, W.S. | Sullivan, Arthur'], :what => ["The Yeomen of the Guard"], :"when/created" => [1888]})
-    h = ANVL.parse({:entry => [""], :who => ['Gilbert, W.S. | Sullivan, Arthur'], :what => ["The Yeomen of the Guard"], :"when/created" => [1888]})
-    assert_match(/entry:/, str)
-    assert_match(/who: Gilbert, W.S. | Sullivan, Arthur/, str)
-    assert_match(/what: The Yeomen of the Guard/, str)
-    assert_match(/when\/created: 1888/, str)
-  end
-
-  def test_display_label
-    h = ANVL::Document.new
-    h['a'] = {:display_label => 'A', :value => '123' }
-    assert_equal("123", h['a'])
-
-    assert_match(/A:/, h.to_s)
-  end
-  
-  def test_str_vs_sym
-    str = 'erc:
-who:    Lederberg, Joshua
-what:   Studies of Human Families for Genetic Linkage
-when:   1974
-where:  http://profiles.nlm.nih.gov/BB/AA/TT/tt.pdf
-note:   This is an arbitrary note inside a
-        small descriptive record.'
-    h = ANVL::Document.parse str
-
-    assert_equal("Lederberg, Joshua", h['who'])
-    assert_equal("Lederberg, Joshua", h[:who])
-  end
-
-end

data/test/test_element.rb

@@ -1,23 +0,0 @@
-require 'helper'
-
-class TestErcElement < Test::Unit::TestCase
-  def test_basic
-    h = ANVL::Erc::Element.new :label => 'abc', :value => '123'
-    assert_equal('123', h.to_s)
-    assert_equal('abc: 123', h.to_anvl)
-  end
-
-  def test_initial_comma_to_recover_natural_word_order
-    h = ANVL::Erc::Element.new :label => 'abc', :value => ',  van Gogh, Vincent'
-    assert_equal('Vincent van Gogh', h.to_s)
-    assert_equal('abc:,  van Gogh, Vincent', h.to_anvl)
-
-    h = ANVL::Erc::Element.new :label => 'abc', :value => ',  Howell, III, PhD, 1922-1987, Thurston'
-    assert_equal('Thurston Howell, III, PhD, 1922-1987', h.to_s)
-    assert_equal('abc:,  Howell, III, PhD, 1922-1987, Thurston', h.to_anvl)
-
-    h = ANVL::Erc::Element.new :label => 'abc', :value => ',  McCartney, Paul, Sir,'
-    assert_equal('Sir Paul McCartney', h.to_s)
-    assert_equal('abc:,  McCartney, Paul, Sir,', h.to_anvl)
-  end
-end

data/test/test_erc.rb

@@ -1,134 +0,0 @@
-require 'helper'
-require 'anvl/erc'
-
-class TestErc < Test::Unit::TestCase
-  def test_parse_empty
-    h = ANVL::Erc.parse ''
-    assert_equal(0, h.entries.length)
-  end
-
-  def test_basic
-    str = 'erc:
-who:    Gibbon, Edward
-what:   The Decline and Fall of the Roman Empire
-when:   1781
-where:  http://www.ccel.org/g/gibbon/decline/'
-
-    h = ANVL::Erc.parse str
-    assert_equal("", h[:erc])
-    assert_equal("Gibbon, Edward", h[:who])
-    assert_equal("The Decline and Fall of the Roman Empire", h[:what])
-    assert_equal("1781", h[:when])
-    assert_equal("http://www.ccel.org/g/gibbon/decline/", h[:where])
-  end  
-
-  def test_complete
-    str = 'erc:
-what:    The Digital Dilemma
-where:  http://books.nap.edu/html/digital%5Fdilemma
-    '
-
-    h = ANVL::Erc.parse str
-    assert_equal(false, h.complete?)
-
-    h[:who] = '---'
-    h[:when] = '---'
-    assert(h.complete?)
-  end
-
-  def test_complete_meta
-    str = 'meta-erc:  NLM | pm9546494 | 19980418
-               | http://ark.nlm.nih.gov/12025/pm9546494??'
-    h = ANVL::Erc.parse str
-    assert(h.complete?)
-  end
-
-  def test_missing_about
-    str = 'about-erc:   | Bispectrum ; Nonlinearity ; Epilepsy
-                   ; Cooperativity ; Subdural ; Hippocampus'
-    h = ANVL::Erc.parse str
-    assert_contains(h['about-what'], 'Bispectrum')
-    assert_contains(h['about-what'], 'Nonlinearity')
-    assert_contains(h['about-what'], 'Epilepsy')
-    assert_contains(h['about-what'], 'Cooperativity')
-    assert_contains(h['about-what'], 'Subdural')
-    assert_contains(h['about-what'], 'Hippocampus')
-  end
-
-  def test_abbr
-    str = 'erc: Gibbon, Edward | The Decline and Fall of the Roman Empire
-         | 1781 | http://www.ccel.org/g/gibbon/decline/'
-
-    h = ANVL::Erc.parse str
-    assert_equal("Gibbon, Edward", h[:who])
-    assert_equal("The Decline and Fall of the Roman Empire", h[:what])
-    assert_equal("1781", h[:when])
-    assert_equal("http://www.ccel.org/g/gibbon/decline/", h[:where])
-  end
-
-  def test_multiple_values
-    str = 'erc:
-who:  Smith, J; Wong, D; Khan, H'
-    h = ANVL::Erc.parse str
-
-    assert_contains(h[:who], 'Smith, J')
-    assert_contains(h[:who], 'Wong, D')
-    assert_contains(h[:who], 'Khan, H')
-  end
-
-  def test_intl
-    str = 'erc:
-who:    Lederberg, Joshua
-h2:   Studies of Human Families for Genetic Linkage'
-    h = ANVL::Erc.parse str
-    assert_equal("Lederberg, Joshua", h[:who])
-    assert_equal("Lederberg, Joshua", h['who'])
-    assert_equal("Lederberg, Joshua", h[:h1])
-    assert_equal("Lederberg, Joshua", h['wer(h1)'])
-    assert_equal("Studies of Human Families for Genetic Linkage", h[:h2])
-    assert_equal("Studies of Human Families for Genetic Linkage", h[:what])
-    assert_equal("Studies of Human Families for Genetic Linkage", h['was(h2)'])
-  end
-
-  def test_label_structure
-    str = 'erc:'
-    h = ANVL::Erc.parse str
-
-    h['marc_856'] = 'abc'
-
-    assert_equal("abc", h['marc_856'])
-    h['MARC 856'] = '123'
-
-    assert_equal("123", h['marc_856'])
-  end
-
-  def test_initial_comma
-    str = 'erc:
-who:,  van Gogh, Vincent
-who:,  Howell, III, PhD, 1922-1987, Thurston
-who:,  Acme Rocket Factory, Inc., The
-who:,  Mao Tse Tung
-who:,  McCartney, Pat, Ms,
-who:,  McCartney, Paul, Sir,
-who:,  McCartney, Petra, Dr,
-what:, Health and Human Services, United States Government
-    Department of, The,'
-
-    h = ANVL::Erc.parse str
-    assert_contains(h[:who], "Vincent van Gogh")
-    assert_contains(h[:who], "Thurston Howell, III, PhD, 1922-1987")
-    assert_contains(h[:who], "The Acme Rocket Factory, Inc.")
-    assert_contains(h[:who], "Mao Tse Tung")
-    assert_contains(h[:who], "Ms Pat McCartney")
-    assert_contains(h[:who], "Sir Paul McCartney")
-    assert_contains(h[:who], "Dr Petra McCartney")
-    assert_equal(h[:what], "The United States Government Department of Health and Human Services")
-  end
-
-  def test_value_encoding
-    str = 'erc:
-who: %sp%ex%dq'
-    h = ANVL::Erc.parse str
-    assert_contains(" !\"", h[:who])
-  end
-end