pairtree 0.0.0 → 0.1.0

data/lib/tasks/rdoc.rake

@@ -0,0 +1,32 @@
+desc "Generate RDoc"
+task :doc => ['doc:generate']
+
+namespace :doc do
+  project_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+  doc_destination = File.join(project_root, 'rdoc')
+
+  begin
+    require 'yard'
+    require 'yard/rake/yardoc_task'
+
+    YARD::Rake::YardocTask.new(:generate) do |yt|
+      yt.files   =  Dir.glob(File.join(project_root, 'lib', '*.rb')) + 
+                    Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
+                   [ File.join(project_root, 'README.rdoc') ] +
+                   [ File.join(project_root, 'LICENSE') ]
+                   
+      yt.options = ['--output-dir', doc_destination, '--readme', 'README.rdoc']
+    end
+  rescue LoadError
+    desc "Generate YARD Documentation"
+    task :generate do
+      abort "Please install the YARD gem to generate rdoc."
+    end
+  end
+
+  desc "Remove generated documenation"
+  task :clean do
+    rm_r doc_destination if File.exists?(doc_destination)
+  end
+
+end

data/pairtree.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name             = %q{pairtree}
+  s.summary          = %q{Ruby Pairtree implementation}
+  s.version          = "0.1.0"
+  s.homepage         = %q{http://github.com/microservices/pairtree}
+  s.licenses         = ["Apache2"]
+  s.rubygems_version = %q{1.3.7}
+
+  s.authors          = ["Chris Beer"]
+  s.date             = %q{2010-12-23}
+  s.email            = %q{chris@cbeer.info}
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.extra_rdoc_files = ["LICENSE.txt", "README.textile"]
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths    = ["lib"]
+
+
+  s.add_development_dependency "bundler", "~> 1.0.0"
+  s.add_development_dependency "rspec", ">= 2.0"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "RedCloth"
+end
+

data/spec/pairtree/pairtree_encoding_spec.rb

@@ -0,0 +1,87 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'pairtree'
+
+describe "Pairtree encoding" do
+
+  def roundtrip(id, expected_encoded=nil, expected_path=nil)
+    encoded = Pairtree::Identifier.encode(id)
+    unless expected_encoded.nil?
+      encoded.should == expected_encoded
+    end
+    unless expected_path.nil?
+      path = Pairtree::Path.id_to_path(id)
+      path.should == expected_path
+    end
+    Pairtree::Identifier.decode(encoded).should == id
+  end
+  
+  it "should handle a" do
+    roundtrip('a', 'a', 'a/a')
+  end
+
+  it "should handle ab" do
+    roundtrip('ab', 'ab', 'ab/ab')
+  end
+
+  it "should handle abc" do
+    roundtrip('abc', 'abc', 'ab/c/abc')
+  end
+
+  it "should handle abcd" do
+    roundtrip('abcd', 'abcd', 'ab/cd/abcd')
+  end
+
+  it "should handle space" do
+    roundtrip('hello world', 'hello^20world', 'he/ll/o^/20/wo/rl/d/hello^20world')
+  end
+
+  it "should handle slash" do
+    roundtrip("/","=",'=/=')
+  end
+
+  it "should handle urn" do
+    roundtrip('http://n2t.info/urn:nbn:se:kb:repos-1','http+==n2t,info=urn+nbn+se+kb+repos-1','ht/tp/+=/=n/2t/,i/nf/o=/ur/n+/nb/n+/se/+k/b+/re/po/s-/1/http+==n2t,info=urn+nbn+se+kb+repos-1')
+  end
+  
+  it "should handle wtf" do
+    roundtrip('what-the-*@?#!^!?', "what-the-^2a@^3f#!^5e!^3f", "wh/at/-t/he/-^/2a/@^/3f/#!/^5/e!/^3/f/what-the-^2a@^3f#!^5e!^3f")
+  end
+
+  it "should handle special characters" do
+    roundtrip('\\"*+,<=>?^|', "^5c^22^2a^2b^2c^3c^3d^3e^3f^5e^7c")
+  end
+  
+  it "should roundtrip hardcore Unicode" do
+    roundtrip(%{
+       1. Euro Symbol: €.
+       2. Greek: Μπορώ να φάω σπασμένα γυαλιά χωρίς να πάθω τίποτα.
+       3. Íslenska / Icelandic: Ég get etið gler án þess að meiða mig.
+       4. Polish: Mogę jeść szkło, i mi nie szkodzi.
+       5. Romanian: Pot să mănânc sticlă și ea nu mă rănește.
+       6. Ukrainian: Я можу їсти шкло, й воно мені не пошкодить.
+       7. Armenian: Կրնամ ապակի ուտել և ինծի անհանգիստ չըներ։
+       8. Georgian: მინას ვჭამ და არა მტკივა.
+       9. Hindi: मैं काँच खा सकता हूँ, मुझे उस से कोई पीडा नहीं होती.
+      10. Hebrew(2): אני יכול לאכול זכוכית וזה לא מזיק לי.
+      11. Yiddish(2): איך קען עסן גלאָז און עס טוט מיר נישט װײ.
+      12. Arabic(2): أنا قادر على أكل الزجاج و هذا لا يؤلمني.
+      13. Japanese: 私はガラスを食べられます。それは私を傷つけません。
+      14. Thai: ฉันกินกระจกได้ แต่มันไม่ทำให้ฉันเจ็บ "
+    })
+  end
+  
+  it "should roundtrip French" do
+    roundtrip('Années de Pèlerinage')
+    roundtrip(%{
+      Années de Pèlerinage (Years of Pilgrimage) (S.160, S.161,
+      S.163) is a set of three suites by Franz Liszt for solo piano. Liszt's
+      complete musical style is evident in this masterwork, which ranges from
+      virtuosic fireworks to sincerely moving emotional statements. His musical
+      maturity can be seen evolving through his experience and travel. The
+      third volume is especially notable as an example of his later style: it
+      was composed well after the first two volumes and often displays less
+      showy virtuosity and more harmonic experimentation.
+    })
+ end
+  
+end

data/spec/pairtree/pairtree_obj_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'pairtree'
+
+describe "Pairtree::Obj" do
+
+  before(:all) do
+    @base_path = File.join(File.dirname(__FILE__), "../test_data/working")
+    Dir.chdir(File.join(File.dirname(__FILE__), "../test_data")) do
+      FileUtils.cp_r('fixtures/pairtree_root_spec', './working')
+    end
+    @root = Pairtree.at(@base_path)
+    @obj = @root.get('pfx:abc123def')
+  end
+  
+  after(:all) do
+    FileUtils.rm_rf(@base_path)
+  end
+  
+  it "should read a file" do
+    @obj.read('content.xml').should == '<content/>'
+  end
+
+  it "should have entries" do
+    @obj.entries.should == ['content.xml']
+  end
+  
+  it "should glob" do
+    @obj['*.xml'].should == ['content.xml']
+    @obj['*.txt'].should == []
+  end
+  
+  it "should be enumerable" do
+    block_body = mock('block_body')
+    block_body.should_receive(:yielded).with('content.xml')
+    @obj.each { |file| block_body.yielded(file) }
+  end
+  
+  describe "Call a bunch of File methods" do
+    before(:each) do
+      @target = File.join(@base_path, 'pairtree_root/ab/c1/23/de/f/abc123def/content.xml')
+    end
+    
+    it "should open a file" do
+      File.should_receive(:open).with(@target,'r')
+      @obj.open('content.xml','r')
+    end
+
+    it "should call delete" do
+      File.should_receive(:delete).with(@target)
+      @obj.delete('content.xml')
+    end
+
+    it "should call link" do
+      File.should_receive(:link).with(@target,@target + '.2')
+      @obj.link('content.xml','content.xml.2')
+    end
+
+    it "should call rename" do
+      File.should_receive(:rename).with(@target,@target + '.new')
+      @obj.rename('content.xml','content.xml.new')
+    end
+
+    it "should call utime" do
+      File.should_receive(:utime).with(0,1,@target)
+      @obj.utime(0,1,'content.xml')
+    end
+  end
+  
+end

data/spec/pairtree/pairtree_path_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'pairtree'
+
+describe "Pairtree::Path" do
+  
+  after(:each) do
+    Pairtree::Path.set_leaf { |id| id }
+  end
+  
+  it "should generate an encoded id as the leaf path by default" do
+    Pairtree::Path.leaf('abc/def').should == "abc=def"
+  end
+
+  it "should accept a nil override" do
+    Pairtree::Path.set_leaf nil
+    Pairtree::Path.leaf('abc/def').should == ""
+  end
+  
+  it "should accept a scalar override" do
+    Pairtree::Path.set_leaf 'obj'
+    Pairtree::Path.leaf('abc/def').should == "obj"
+  end
+  
+  it "should accept a Proc override" do
+    lp = Proc.new { |id| id.reverse }
+    Pairtree::Path.set_leaf(lp)
+    Pairtree::Path.leaf('abc/def').should == "fed=cba"
+  end
+  
+  it "should accept a block override" do
+    Pairtree::Path.set_leaf { |id| id.reverse }
+    Pairtree::Path.leaf('abc/def').should == "fed=cba"
+  end
+  
+end

data/spec/pairtree/pairtree_root_spec.rb

@@ -0,0 +1,63 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'pairtree'
+
+describe "Pairtree::Root" do
+  
+  before(:all) do
+    @base_path = File.join(File.dirname(__FILE__), "../test_data/working")
+    Dir.chdir(File.join(File.dirname(__FILE__), "../test_data")) do
+      FileUtils.cp_r('fixtures/pairtree_root_spec', './working')
+    end
+    @root = Pairtree.at(@base_path)
+  end
+  
+  after(:all) do
+    FileUtils.rm_rf(@base_path)
+  end
+  
+  it "should have the correct prefix" do
+    @root.prefix.should == 'pfx:'
+  end
+  
+  it "should be in the correct location" do
+    File.expand_path(@root.path).should == File.expand_path(@base_path)
+    File.expand_path(@root.root).should == File.expand_path(File.join(@base_path, "pairtree_root"))
+  end
+  
+  it "should list identifiers" do
+    @root.list.should == ['pfx:abc123def']
+  end
+  
+  it "should verify whether an identifier exists" do
+    @root.exists?('pfx:abc123def').should be_true
+    @root.exists?('pfx:abc123jkl').should be_false
+  end
+  
+  it "should raise an exception if an invalid prefix is used" do
+    lambda { @root.exists?('xfp:abc123def') }.should raise_error(Pairtree::IdentifierError)
+  end
+  
+  it "should get a ppath for a valid ID" do
+    obj = @root.get 'pfx:abc123def'
+    obj.class.should == Pairtree::Obj
+    File.expand_path(obj.path).should == File.expand_path(File.join(@base_path, "pairtree_root/ab/c1/23/de/f/abc123def/"))
+  end
+  
+  it "should raise an exception when attempting to get a ppath for an invalid ID" do
+    lambda { @root.get 'pfx:abc123jkl' }.should raise_error(Errno::ENOENT)
+  end
+  
+  it "should create a new ppath" do
+    obj = @root.mk 'pfx:abc123jkl'
+    obj.class.should == Pairtree::Obj
+    File.expand_path(obj.path).should == File.expand_path(File.join(@base_path, "pairtree_root/ab/c1/23/jk/l/abc123jkl/"))
+    @root.exists?('pfx:abc123jkl').should be_true
+  end
+  
+  it "should delete a ppath" do
+    @root.exists?('pfx:abc123jkl').should be_true
+    @root.purge!('pfx:abc123jkl')
+    @root.exists?('pfx:abc123jkl').should be_false
+  end
+  
+end

data/spec/pairtree/pairtree_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'pairtree'
+
+describe "Pairtree" do
+  
+  before(:all) do
+    @base_path = File.join(File.dirname(__FILE__), "../test_data/working")
+  end
+  
+  it "should raise an error if a non-existent is specified without :create" do
+    lambda { Pairtree.at(@base_path) }.should raise_error(Pairtree::PathError)
+  end
+
+  describe "new pairtree" do
+    after(:all) do
+      FileUtils.rm_rf(@base_path)
+    end
+
+    it "should create a new pairtree" do
+      prefix = 'my_prefix:'
+      pt = Pairtree.at(@base_path, :prefix => prefix, :create => true)
+      pt.prefix.should == prefix
+      File.read(File.join(@base_path, 'pairtree_prefix')).should == prefix
+      pt.root.should == File.join(@base_path, 'pairtree_root')
+      pt.pairtree_version.should == Pairtree::SPEC_VERSION
+    end
+    
+  end
+  
+  describe "existing pairtree" do
+    before(:all) do
+      Dir.chdir(File.join(File.dirname(__FILE__), "../test_data")) do
+        FileUtils.cp_r('fixtures/pairtree_root_spec', './working')
+      end
+    end
+    
+    after(:all) do
+      FileUtils.rm_rf(@base_path)
+    end
+
+    it "should raise an error if a regular file is specified as a root" do
+      lambda { Pairtree.at(File.join(@base_path, "pairtree_prefix"), :create => true) }.should raise_error(Pairtree::PathError)
+    end
+    
+    it "should read the prefix if none is specified" do
+      Pairtree.at(@base_path).prefix.should == File.read(File.join(@base_path, 'pairtree_prefix'))
+    end
+
+    it "should not complain if the given prefix matches the saved prefix" do
+      Pairtree.at(@base_path, :prefix => 'pfx:').prefix.should == File.read(File.join(@base_path, 'pairtree_prefix'))
+    end
+    
+    it "should raise an error if the given prefix does not match the saved prefix" do
+      lambda { Pairtree.at(@base_path, :prefix => 'wrong-prefix:') }.should raise_error(Pairtree::IdentifierError)
+    end
+    
+    it "should not complain if the given version matches the saved version" do
+      Pairtree.at(@base_path, :version => Pairtree::SPEC_VERSION).pairtree_version.should == Pairtree::SPEC_VERSION
+      Pairtree.at(@base_path, :version => Pairtree::SPEC_VERSION, :create => true).pairtree_version.should == Pairtree::SPEC_VERSION
+    end
+
+    it "should raise an error if the given version does not match the saved version" do
+      lambda { Pairtree.at(@base_path, :version => 0.2) }.should raise_error(Pairtree::VersionMismatch)
+      lambda { Pairtree.at(@base_path, :version => 0.2, :create => true) }.should raise_error(Pairtree::VersionMismatch)
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'bundler/setup'
+require 'rspec'
+require 'rspec/autorun'
+
+RSpec.configure do |config|
+  
+end

data/spec/test_data/fixtures/pairtree_root_spec/pairtree_prefix

@@ -0,0 +1 @@
+pfx:

data/spec/test_data/fixtures/pairtree_root_spec/pairtree_root/ab/c1/23/de/f/abc123def/content.xml

@@ -0,0 +1 @@
+<content/>

data/spec/test_data/fixtures/pairtree_root_spec/pairtree_version0_1

@@ -0,0 +1 @@
+This directory conforms to Pairtree Version 0.1. Updated spec: http://www.cdlib.org/inside/diglib/pairtree/pairtreespec.html

metadata

@@ -1,141 +1,123 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pairtree
-version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 0
-  version: 0.0.0
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Chris Beer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-23 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2010-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2164523720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :development
   prerelease: false
-  name: shoulda
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *2164523720
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2164523000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
-  name: bundler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2164523000
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2164522020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2164522020
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  requirement: &2164521500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  name: rcov
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id004
+  version_requirements: *2164521500
 description: 
 email: chris@cbeer.info
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
-files: 
+- README.textile
+files:
 - .document
+- .gitignore
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.textile
 - Rakefile
-- VERSION
 - lib/pairtree.rb
-- lib/pairtree/client.rb
 - lib/pairtree/identifier.rb
 - lib/pairtree/obj.rb
 - lib/pairtree/path.rb
 - lib/pairtree/root.rb
-- test/helper.rb
-- test/test_pairtree.rb
-has_rdoc: true
-homepage: http://github.com/cbeer/pairtree
-licenses: 
-- MIT
+- lib/tasks/rdoc.rake
+- pairtree.gemspec
+- spec/pairtree/pairtree_encoding_spec.rb
+- spec/pairtree/pairtree_obj_spec.rb
+- spec/pairtree/pairtree_path_spec.rb
+- spec/pairtree/pairtree_root_spec.rb
+- spec/pairtree/pairtree_spec.rb
+- spec/spec_helper.rb
+- spec/test_data/fixtures/pairtree_root_spec/pairtree_prefix
+- spec/test_data/fixtures/pairtree_root_spec/pairtree_root/ab/c1/23/de/f/abc123def/content.xml
+- spec/test_data/fixtures/pairtree_root_spec/pairtree_version0_1
+homepage: http://github.com/microservices/pairtree
+licenses:
+- Apache2
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby Pairtree implementation
-test_files: 
-- test/helper.rb
-- test/test_pairtree.rb
+test_files:
+- spec/pairtree/pairtree_encoding_spec.rb
+- spec/pairtree/pairtree_obj_spec.rb
+- spec/pairtree/pairtree_path_spec.rb
+- spec/pairtree/pairtree_root_spec.rb
+- spec/pairtree/pairtree_spec.rb
+- spec/spec_helper.rb
+- spec/test_data/fixtures/pairtree_root_spec/pairtree_prefix
+- spec/test_data/fixtures/pairtree_root_spec/pairtree_root/ab/c1/23/de/f/abc123def/content.xml
+- spec/test_data/fixtures/pairtree_root_spec/pairtree_version0_1
+has_rdoc: