switch to rspec

Author: cbeer

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

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.rdoc']
+  end
+rescue LoadError
+  desc "Generate YARD Documentation"
+  task :doc do
+    abort "Please install the YARD gem to generate rdoc."
+  end
 end
+

VERSION

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

anvl.gemspec

@@ -1,70 +1,28 @@
-# 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.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"
-  ]
 
-  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
 

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
+

spec/.anvl_spec.rb.swp

@@ -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
+

spec/anvl_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