druid-tools 0.2.6

data/druid-tools.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Michael Klein', 'Darren Hardy']
+  gem.email         = ['mbklein@stanford.edu']
+  gem.description   = 'Tools to manipulate DRUID trees and content directories'
+  gem.summary       = 'Tools to manipulate DRUID trees and content directories'
+  gem.homepage      = 'http://github.com/sul-dlss/druid-tools'
+  gem.licenses      = ['ALv2', 'Stanford University Libraries']
+  gem.has_rdoc      = true
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.name          = 'druid-tools'
+  gem.require_paths = ['lib']
+  gem.version       = File.read('VERSION').strip
+  
+  gem.add_development_dependency 'rake', '>= 10.1.0'
+  gem.add_development_dependency 'rspec', '>= 2.14.0'
+end

data/lib/druid-tools.rb

@@ -0,0 +1 @@
+require 'druid_tools'

data/lib/druid_tools.rb

@@ -0,0 +1,5 @@
+module DruidTools
+  require 'druid_tools/version'
+  require 'druid_tools/druid'
+  require 'druid_tools/exceptions'
+end

data/lib/druid_tools/druid.rb

@@ -0,0 +1,127 @@
+require 'pathname'
+
+module DruidTools
+  class Druid
+    attr_accessor :druid, :base
+    
+    class << self
+      attr_accessor :prefix
+      
+      # @return [Regexp] matches druid:aa111aa1111 or aa111aa1111
+      def pattern
+        /\A(?:#{self.prefix}:)?([a-z]{2})(\d{3})([a-z]{2})(\d{4})\z/
+      end
+
+      # @return [String] suitable for use in [Dir#glob]
+      def glob
+        "{#{self.prefix}:,}[a-z][a-z][0-9][0-9][0-9][a-z][a-z][0-9][0-9][0-9][0-9]"
+      end
+
+      # @param [String] druid id
+      # @return [Boolean] true if druid matches pattern; otherwise false
+      def valid?(druid)
+        return druid =~ pattern ? true : false
+      end
+
+    end
+    self.prefix = 'druid'
+    
+    [:content, :metadata, :temp].each do |dir_type|
+      self.class_eval <<-EOC
+        def #{dir_type}_dir(create=true)
+          path("#{dir_type}",create)
+        end
+        
+        def find_#{dir_type}(path)
+          find(:#{dir_type},path)
+        end
+      EOC
+    end
+    
+    # @param druid [String] A valid druid
+    # @param base [String] The directory used by #path
+    def initialize(druid, base='.')
+      druid = druid.to_s unless druid.is_a? String
+      unless self.class.valid?(druid)
+        raise ArgumentError, "Invalid DRUID: '#{druid}'"
+      end
+      druid = [self.class.prefix,druid].join(':') unless druid =~ /^#{self.class.prefix}:/
+      @base = base
+      @druid = druid
+    end
+  
+    def id
+      @druid.scan(self.class.pattern).flatten.join('')
+    end
+  
+    def tree
+      @druid.scan(self.class.pattern).flatten + [id]
+    end
+  
+    def path(extra=nil, create=false)
+      result = File.join(*([base,tree,extra].compact))
+      mkdir(extra) if create and not File.exists?(result)
+      result
+    end
+    
+    def mkdir(extra=nil)
+      new_path = path(extra)
+      if(File.symlink? new_path)
+        raise DruidTools::DifferentContentExistsError, "Unable to create directory, link already exists: #{new_path}"
+      end
+      if(File.directory? new_path)
+        raise DruidTools::SameContentExistsError, "The directory already exists: #{new_path}"
+      end
+      FileUtils.mkdir_p(new_path)
+    end
+    
+    def find(type, path)
+      possibles = [self.path(type.to_s),self.path,File.expand_path('..',self.path)]
+      loc = possibles.find { |p| File.exists?(File.join(p,path)) }
+      loc.nil? ? nil : File.join(loc,path)
+    end
+
+    # @param [String] type The type of directory being sought ('content', 'metadata', or 'temp')
+    # @param [Array<String>,String] filelist The files that are expected to be present in the directory
+    # @return [Pathname] Search for and return the pathname of the directory that contains the list of files.
+    #    Raises an exception unless a directory is found that contains all the files in the list.
+    def find_filelist_parent(type, filelist)
+      raise "File list not specified" if filelist.nil? or filelist.empty?
+      filelist = [filelist] unless filelist.is_a?(Array)
+      search_dir = Pathname(self.path(type))
+      directories = [search_dir, search_dir.parent, search_dir.parent.parent]
+      found_dir = directories.find { |pathname| pathname.join(filelist[0]).exist? }
+      raise "#{type} dir not found for '#{filelist[0]}' when searching '#{search_dir}'" if found_dir.nil?
+      filelist.each do |filename|
+        raise "File '#{filename}' not found in #{type} dir s'#{found_dir}'" unless found_dir.join(filename).exist?
+      end
+      found_dir
+    end
+
+    def mkdir_with_final_link(source, extra=nil)
+      new_path = path(extra)
+      if(File.directory?(new_path) && !File.symlink?(new_path))
+        raise DruidTools::DifferentContentExistsError, "Unable to create link, directory already exists: #{new_path}"
+      end
+      real_path = File.expand_path('..',new_path)
+      FileUtils.mkdir_p(real_path)
+      FileUtils.ln_s(source, new_path, :force=>true)
+    end
+  
+    def rmdir(extra=nil)
+      parts = tree
+      parts << extra unless extra.nil?
+      while parts.length > 0
+        dir = File.join(base, *parts)
+        begin
+          FileUtils.rm(File.join(dir,'.DS_Store'), :force => true)
+          FileUtils.rmdir(dir)
+        rescue Errno::ENOTEMPTY
+          break
+        end
+        parts.pop
+      end
+    end
+
+  end
+end

data/lib/druid_tools/exceptions.rb

@@ -0,0 +1,5 @@
+module DruidTools
+  class SameContentExistsError < Exception; end
+  class DifferentContentExistsError < Exception; end
+  class InvalidDruidError < Exception; end
+end

data/lib/druid_tools/version.rb

@@ -0,0 +1,3 @@
+module DruidTools
+  VERSION = File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'VERSION'))).to_s.strip
+end

data/spec/druid_tools_spec.rb

@@ -0,0 +1,255 @@
+#require File.expand_path('../spec_helper',__FILE__)
+#puts $LOAD_PATH.join("\n")
+require 'druid-tools'
+
+describe DruidTools::Druid do
+  before (:all) do
+    @fixture_dir = File.expand_path("../fixtures",__FILE__)
+    FileUtils.rm_rf(File.join(@fixture_dir,'cd'))
+    @druid_1 = 'druid:cd456ef7890'
+    @tree_1 = File.join(@fixture_dir,'cd/456/ef/7890/cd456ef7890')
+    @druid_2 = 'druid:cd456gh1234'
+    @tree_2 = File.join(@fixture_dir,'cd/456/gh/1234/cd456gh1234')
+  end
+  
+  after(:each) do
+    FileUtils.rm_rf(File.join(@fixture_dir,'cd'))
+  end
+
+  it "should be able to validate druid strings using the valid? class method" do
+    tests = [
+      # Expected     Input druid
+      [true,         'druid:aa000bb0001'],
+      [true,         'aa000bb0001'],
+      [false,        'Aa000bb0001'],
+      [false,        "xxx\naa000bb0001"],
+      [false,        'aaa000bb0001'],
+      [false,        'druidX:aa000bb0001'],
+      [false,        ':aa000bb0001'],
+      [true,         'aa123bb1234'],
+      [false,        'aa12bb1234'],
+      [false,        'aa1234bb1234'],
+      [false,        'aa123bb123'],
+      [false,        'aa123bb12345'],
+      [false,        'a123bb1234'],
+      [false,        'aaa123bb1234'],
+      [false,        'aa123b1234'],
+      [false,        'aa123bbb1234'],
+      [false,        'druid:az918AZ9381'.upcase],
+      [true,         'druid:az918AZ9381'.downcase],
+      [true,         'druid:zz943vx1492']
+    ]
+    tests.each do |exp, dru|
+      DruidTools::Druid.valid?(dru).should == exp
+    end
+  end
+
+  it "should provide the full druid including the prefix" do
+    DruidTools::Druid.new('druid:cd456ef7890',@fixture_dir).druid.should == 'druid:cd456ef7890'
+    DruidTools::Druid.new('cd456ef7890',@fixture_dir).druid.should == 'druid:cd456ef7890'
+  end
+  
+  it "should extract the ID from the stem" do
+    DruidTools::Druid.new('druid:cd456ef7890',@fixture_dir).id.should == 'cd456ef7890'
+    DruidTools::Druid.new('cd456ef7890',@fixture_dir).id.should == 'cd456ef7890'
+  end
+  
+  it "should raise an exception if the druid is invalid" do
+    lambda { DruidTools::Druid.new('nondruid:cd456ef7890',@fixture_dir) }.should raise_error(ArgumentError)
+    lambda { DruidTools::Druid.new('druid:cd4567ef890',@fixture_dir) }.should raise_error(ArgumentError)
+  end
+  
+  it "should build a druid tree from a druid" do
+    druid = DruidTools::Druid.new(@druid_1,@fixture_dir)
+    druid.tree.should == ['cd','456','ef','7890','cd456ef7890']
+    druid.path.should == @tree_1
+  end
+  
+  it "should create and destroy druid directories" do
+    File.exists?(@tree_1).should be_false
+    File.exists?(@tree_2).should be_false
+
+    druid_1 = DruidTools::Druid.new(@druid_1,@fixture_dir)
+    druid_2 = DruidTools::Druid.new(@druid_2,@fixture_dir)
+
+    druid_1.mkdir
+    File.exists?(@tree_1).should be_true
+    File.exists?(@tree_2).should be_false
+
+    druid_2.mkdir
+    File.exists?(@tree_1).should be_true
+    File.exists?(@tree_2).should be_true
+    
+    druid_2.rmdir
+    File.exists?(@tree_1).should be_true
+    File.exists?(@tree_2).should be_false
+
+    druid_1.rmdir
+    File.exists?(@tree_1).should be_false
+    File.exists?(@tree_2).should be_false
+    File.exists?(File.join(@fixture_dir,'cd')).should be_false
+  end
+
+  describe "alternate prefixes" do
+    before :all do
+      DruidTools::Druid.prefix = 'sulair'
+    end
+    
+    after :all do
+      DruidTools::Druid.prefix = 'druid'
+    end
+
+    it "should handle alternate prefixes" do
+      lambda { DruidTools::Druid.new('druid:cd456ef7890',@fixture_dir) }.should raise_error(ArgumentError)
+      DruidTools::Druid.new('sulair:cd456ef7890',@fixture_dir).id.should == 'cd456ef7890'
+      DruidTools::Druid.new('cd456ef7890',@fixture_dir).druid.should == 'sulair:cd456ef7890'
+    end
+  end
+  
+  describe "content directories" do
+    it "should know where its content goes" do
+      druid = DruidTools::Druid.new(@druid_1,@fixture_dir)
+      druid.content_dir(false).should  == File.join(@tree_1,'content')
+      druid.metadata_dir(false).should == File.join(@tree_1,'metadata')
+      druid.temp_dir(false).should     == File.join(@tree_1,'temp')
+    
+      File.exists?(File.join(@tree_1,'content')).should be_false
+      File.exists?(File.join(@tree_1,'metadata')).should be_false
+      File.exists?(File.join(@tree_1,'temp')).should be_false
+    end
+
+    it "should create its content directories on the fly" do
+      druid = DruidTools::Druid.new(@druid_1,@fixture_dir)
+      druid.content_dir.should  == File.join(@tree_1,'content')
+      druid.metadata_dir.should == File.join(@tree_1,'metadata')
+      druid.temp_dir.should     == File.join(@tree_1,'temp')
+    
+      File.exists?(File.join(@tree_1,'content')).should be_true
+      File.exists?(File.join(@tree_1,'metadata')).should be_true
+      File.exists?(File.join(@tree_1,'temp')).should be_true
+    end
+  
+    it "should match glob" do
+      druid = DruidTools::Druid.new(@druid_1,@fixture_dir)
+      druid.mkdir
+      Dir.glob(File.join(File.dirname(druid.path), DruidTools::Druid::glob)).size.should == 1
+    end
+  end
+  
+  describe "content discovery" do
+    before :all do
+      @druid = DruidTools::Druid.new(@druid_1,@fixture_dir)
+      @filelist = %w(1 2 3 4).collect { |num| "someFile#{num}" }
+    end
+    
+    it "should find content in content directories" do
+      location = @druid.content_dir
+      File.open(File.join(location,'someContent'),'w') { |f| f.write 'This is the content' }
+      @druid.find_content('someContent').should == File.join(location,'someContent')
+    end
+    
+    it "should find content in the root directory" do
+      location = @druid.path(nil,true)
+      File.open(File.join(location,'someContent'),'w') { |f| f.write 'This is the content' }
+      @druid.find_content('someContent').should == File.join(location,'someContent')
+    end
+
+    it "should find content in the leaf directory" do
+      location = File.expand_path('..',@druid.path(nil,true))
+      File.open(File.join(location,'someContent'),'w') { |f| f.write 'This is the content' }
+      @druid.find_content('someContent').should == File.join(location,'someContent')
+    end
+    
+    it "should not find content in the wrong content directory" do
+      location = @druid.metadata_dir
+      File.open(File.join(location,'someContent'),'w') { |f| f.write 'This is the content' }
+      @druid.find_content('someContent').should be_nil
+    end
+
+    it "should not find content in a higher-up directory" do
+      location = File.expand_path('../..',@druid.path(nil,true))
+      File.open(File.join(location,'someContent'),'w') { |f| f.write 'This is the content' }
+      @druid.find_content('someContent').should be_nil
+    end
+
+    it "should find a filelist in the content directory" do
+      location = Pathname(@druid.content_dir)
+      @filelist.each do |filename|
+        location.join(filename).open('w') { |f| f.write "This is #{filename}" }
+      end
+      @druid.find_filelist_parent('content',@filelist).should == location
+    end
+
+    it "should find a filelist in the root directory" do
+      location = Pathname(@druid.path(nil,true))
+      @filelist.each do |filename|
+        location.join(filename).open('w') { |f| f.write "This is #{filename}" }
+      end
+      @druid.find_filelist_parent('content',@filelist).should == location
+    end
+
+    it "should find a filelist in the leaf directory" do
+      location = Pathname(File.expand_path('..',@druid.path(nil,true)))
+      @filelist.each do |filename|
+        location.join(filename).open('w') { |f| f.write "This is #{filename}" }
+      end
+      @druid.find_filelist_parent('content',@filelist).should == location
+    end
+
+    it "should raise an exception if the first file in the filelist is not found" do
+      location = Pathname(@druid.content_dir)
+      lambda{@druid.find_filelist_parent('content',@filelist)}.should raise_exception(/content dir not found for 'someFile1' when searching/)
+    end
+
+    it "should raise an exception if any other file in the filelist is not found" do
+      location = Pathname(@druid.content_dir)
+      location.join(@filelist.first).open('w') { |f| f.write "This is #{@filelist.first}" }
+      lambda{@druid.find_filelist_parent('content',@filelist)}.should raise_exception(/File 'someFile2' not found/)
+    end
+
+  end
+  
+  describe "#mkdir error handling" do
+    it "raises SameContentExistsError if the directory already exists" do
+      druid_2 = DruidTools::Druid.new(@druid_2,@fixture_dir)
+      druid_2.mkdir
+      lambda { druid_2.mkdir }.should raise_error(DruidTools::SameContentExistsError)
+    end
+    
+    it "raises DifferentContentExistsError if a link already exists in the workspace for this druid" do
+      source_dir = '/tmp/content_dir'
+      FileUtils.mkdir_p(source_dir)      
+      dr = DruidTools::Druid.new(@druid_2,@fixture_dir)
+      dr.mkdir_with_final_link(source_dir)
+      lambda { dr.mkdir }.should raise_error(DruidTools::DifferentContentExistsError)
+    end
+  end
+  
+  describe "#mkdir_with_final_link" do
+    
+    before(:each) do
+      @source_dir = '/tmp/content_dir'
+      FileUtils.mkdir_p(@source_dir)      
+      @dr = DruidTools::Druid.new(@druid_2,@fixture_dir)
+    end
+    
+    it "creates a druid tree in the workspace with the final directory being a link to the passed in source" do
+      @dr.mkdir_with_final_link(@source_dir)
+
+      File.should be_symlink(@dr.path)
+      File.readlink(@tree_2).should == @source_dir
+    end
+    
+    it "should not error out if the link to source already exists" do
+      @dr.mkdir_with_final_link(@source_dir)
+      File.should be_symlink(@dr.path)
+      File.readlink(@tree_2).should == @source_dir
+    end
+    
+    it "raises DifferentContentExistsError if a directory already exists in the workspace for this druid" do
+      @dr.mkdir(@fixture_dir)
+      lambda { @dr.mkdir_with_final_link(@source_di) }.should raise_error(DruidTools::DifferentContentExistsError)
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+#$LOAD_PATH.unshift(File.expand_path('../../lib',__FILE__))
+
+require 'bundler/setup'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: druid-tools
+version: !ruby/object:Gem::Version
+  version: 0.2.6
+  prerelease: 
+platform: ruby
+authors:
+- Michael Klein
+- Darren Hardy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+description: Tools to manipulate DRUID trees and content directories
+email:
+- mbklein@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- doc/classes/DruidTools.html
+- doc/classes/DruidTools/DifferentContentExistsError.html
+- doc/classes/DruidTools/Druid.html
+- doc/classes/DruidTools/Druid.src/M000001.html
+- doc/classes/DruidTools/Druid.src/M000002.html
+- doc/classes/DruidTools/Druid.src/M000003.html
+- doc/classes/DruidTools/Druid.src/M000004.html
+- doc/classes/DruidTools/Druid.src/M000005.html
+- doc/classes/DruidTools/Druid.src/M000006.html
+- doc/classes/DruidTools/Druid.src/M000007.html
+- doc/classes/DruidTools/Druid.src/M000008.html
+- doc/classes/DruidTools/Druid.src/M000009.html
+- doc/classes/DruidTools/Druid.src/M000010.html
+- doc/classes/DruidTools/Druid.src/M000011.html
+- doc/classes/DruidTools/Druid.src/M000012.html
+- doc/classes/DruidTools/InvalidDruidError.html
+- doc/classes/DruidTools/SameContentExistsError.html
+- doc/created.rid
+- doc/files/lib/druid-tools_rb.html
+- doc/files/lib/druid_tools/druid_rb.html
+- doc/files/lib/druid_tools/exceptions_rb.html
+- doc/files/lib/druid_tools/version_rb.html
+- doc/files/lib/druid_tools_rb.html
+- doc/files/spec/druid_tools_spec_rb.html
+- doc/files/spec/spec_helper_rb.html
+- doc/fr_class_index.html
+- doc/fr_file_index.html
+- doc/fr_method_index.html
+- doc/index.html
+- doc/rdoc-style.css
+- druid-tools.gemspec
+- lib/druid-tools.rb
+- lib/druid_tools.rb
+- lib/druid_tools/druid.rb
+- lib/druid_tools/exceptions.rb
+- lib/druid_tools/version.rb
+- spec/druid_tools_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/sul-dlss/druid-tools
+licenses:
+- ALv2
+- Stanford University Libraries
+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: -3564401623141727809
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3564401623141727809
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Tools to manipulate DRUID trees and content directories
+test_files:
+- spec/druid_tools_spec.rb
+- spec/spec_helper.rb