druid-tools 0.2.6 → 0.3.0

data/.gitignore

@@ -13,4 +13,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-Gemfile.lock
+.rvmrc
+.ruby-version
+.ruby-gemset
+

data/Gemfile

@@ -1,4 +1,12 @@
 source 'https://rubygems.org'
+source 'http://sul-gems.stanford.edu'
+
+group :development do
+  gem "ruby-debug", :platform => :ruby_18
+  gem "rcov", :platform => :ruby_18
+  gem "simplecov", :platform => [:ruby_19, :ruby_20]
+  gem "debugger", :platform => :ruby_19
+  gem "pry-debugger", :platform => :ruby_19
+end
 
-# Specify your gem's dependencies in druid-tools.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    druid-tools (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  remote: http://sul-gems.stanford.edu/
+  specs:
+    coderay (1.0.9)
+    columnize (0.3.6)
+    debugger (1.6.2)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    diff-lcs (1.2.4)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    lyberteam-gems-devel (1.0.1)
+      rake (>= 0.8.7)
+      rest-client
+    method_source (0.8.2)
+    mime-types (1.24)
+    multi_json (1.8.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-debugger (0.2.2)
+      debugger (~> 1.3)
+      pry (~> 0.9.10)
+    rake (10.1.0)
+    rbx-require-relative (0.0.9)
+    rcov (1.0.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  druid-tools!
+  lyberteam-gems-devel (~> 1.0.0)
+  pry-debugger
+  rake (~> 10.1.0)
+  rcov
+  rspec (~> 2.14.0)
+  ruby-debug
+  simplecov

data/README.md

@@ -35,7 +35,7 @@ Tools to manipulate DRUID trees and content directories
     d.rmdir
     # Link content from another source into a druid tree
     d.mkdir_with_final_link('/some/other/content/location')
-    
+
 ### Content-specific methods create the relevant directories if they don't exist
 
 Pass `false` as a parameter to prevent directory creation, or `true` (default) to create directories.
@@ -50,25 +50,45 @@ Pass `false` as a parameter to prevent directory creation, or `true` (default) t
     => "/dor/workspace/ab/123/cd/4567/ab123cd4567/metadata"
     d.temp_dir(false)
     => "/dor/workspace/ab/123/cd/4567/ab123cd4567/temp"
-    
+
 ### Locate existing content within the druid tree
 
     # In the correct directory
     d.find_metadata('contentMetadata.xml')
     => "/dor/workspace/ab/123/cd/4567/ab123cd4567/metadata/contentMetadata.xml"
-    
+
     # In other known previous locations, for backward compatibility
     d.find_metadata('contentMetadata.xml')
     => "/dor/workspace/ab/123/cd/4567/ab123cd4567/contentMetadata.xml"
 
     d.find_metadata('contentMetadata.xml')
     => "/dor/workspace/ab/123/cd/4567/contentMetadata.xml"
-    
+
     d.find_content('this/file/does/not/exist.jpg')
     => nil
-    
-## History
 
+### Pruning: removes leaves of tree up to non-empty branches
+
+    d1 = DruidTools::Druid.new 'druid:cd456ef7890', '/workspace'
+    d1.mkdir
+    d2 = DruidTools::Druid.new 'druid:cd456gh1234', '/workspace'
+    d2.mkdir
+
+    # /workspace/cd/456/gh/1234/cd456gh1234 pruned down to /workspace/cd/456
+    # /workspace/cd/456/ef/7890/cd456ef7890 left intact
+    d2.prune!
+
+### Stacks and Purl compatible Druid.  All files at the leaf directories
+
+    pd = DruidTools::PurlDruid.new 'druid:ab123cd4567', '/purl'
+    pd.path
+    => "/purl/ab/123/cd/4567"
+    pd.content_dir
+    => "/purl/ab/123/cd/4567"
+
+### History
+
+- <b>0.3.0</b> - Added #prune method. Added AccessDruid for stacks and purl access
 - <b>0.2.6</b> - Fixed VERSION warning message, and documentation cleanup
 - <b>0.2.5</b> - Added glob pattern as DruidTools::Druid.glob
 - <b>0.2.4</b> - Allow non-String as .new parameter and added InvalidDruidError
@@ -77,4 +97,4 @@ Pass `false` as a parameter to prevent directory creation, or `true` (default) t
 - <b>0.2.1</b> - Do not error out during symlink creation if it already exists
 - <b>0.2.0</b> - Added DruidTools::Druid.valid?
 - <b>0.1.0</b> - Additional support for alternate content locations
-- <b>0.0.1</b> - Initial Release 
+- <b>0.0.1</b> - Initial Release

data/Rakefile

@@ -4,4 +4,7 @@ require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
+require 'dlss/rake/dlss_release'
+Dlss::Release.new
+
 task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.2.6
+0.3.0

data/druid-tools.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   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'
+  gem.add_development_dependency 'rake', '~> 10.1.0'
+  gem.add_development_dependency 'rspec', '~> 2.14.0'
+  gem.add_development_dependency 'lyberteam-gems-devel', '~> 1.0.0'
 end

data/lib/druid_tools.rb

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

data/lib/druid_tools/access_druid.rb

@@ -0,0 +1,25 @@
+
+module DruidTools
+
+  # Overrides the Druid#tree method
+  class AccessDruid < Druid
+
+    self.prefix = 'druid'
+
+    def tree
+      @druid.scan(self.class.pattern).flatten
+    end
+
+    # all content lives in the base druid directory
+    def path(extra=nil, create=false)
+      result = File.join(*([base,tree].compact))
+      mkdir(extra) if create and not File.exists?(result)
+      result
+    end
+
+  end
+
+  PurlDruid = AccessDruid
+  StacksDruid = AccessDruid
+
+end

data/lib/druid_tools/druid.rb

@@ -3,10 +3,10 @@ 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/
@@ -25,19 +25,19 @@ module DruidTools
 
     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='.')
@@ -49,21 +49,21 @@ module DruidTools
       @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)
@@ -74,7 +74,7 @@ module DruidTools
       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)) }
@@ -107,7 +107,7 @@ module DruidTools
       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?
@@ -123,5 +123,33 @@ module DruidTools
       end
     end
 
+    def pathname
+      Pathname self.path
+    end
+
+    def base_pathname
+      Pathname self.base
+    end
+
+    def prune!
+      this_path = pathname
+      parent = this_path.parent
+      parent.rmtree if parent.exist? && parent != base_pathname
+      prune_ancestors parent.parent
+    end
+
+  protected
+
+    # @param [Pathname] outermost_branch The branch at which pruning begins
+    # @return [void] Ascend the druid tree and prune empty branches
+    def prune_ancestors(outermost_branch)
+      while outermost_branch.children.size == 0
+        outermost_branch.rmdir
+        outermost_branch = outermost_branch.parent
+        break if  outermost_branch == base_pathname
+      end
+    rescue
+    end
+
   end
 end

data/spec/access_druid_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe DruidTools::PurlDruid do
+
+    let(:purl_root) { Dir.mktmpdir }
+
+    let(:druid) { DruidTools::PurlDruid.new 'druid:cd456ef7890', purl_root }
+
+    after(:each) do
+      FileUtils.remove_entry purl_root
+    end
+
+    it "overrides Druid#tree so that the leaf is not Druid#id" do
+      expect(druid.tree).to eq(['cd','456','ef','7890'])
+    end
+
+    describe "#content_dir" do
+
+      it "creates content directories at leaf of the druid tree" do
+        expect(druid.content_dir).to match(/ef\/7890$/)
+      end
+
+      it "does not create a 'content' subdirectory" do
+        expect(druid.content_dir).to_not match(/content$/)
+      end
+    end
+
+end

data/spec/druid_tools_spec.rb

@@ -1,6 +1,6 @@
-#require File.expand_path('../spec_helper',__FILE__)
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 #puts $LOAD_PATH.join("\n")
-require 'druid-tools'
+require 'tmpdir'
 
 describe DruidTools::Druid do
   before (:all) do
@@ -11,7 +11,7 @@ describe DruidTools::Druid do
     @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
@@ -48,23 +48,23 @@ describe DruidTools::Druid 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
@@ -79,7 +79,7 @@ describe DruidTools::Druid do
     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
@@ -94,7 +94,7 @@ describe DruidTools::Druid do
     before :all do
       DruidTools::Druid.prefix = 'sulair'
     end
-    
+
     after :all do
       DruidTools::Druid.prefix = 'druid'
     end
@@ -105,14 +105,14 @@ describe DruidTools::Druid do
       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
@@ -123,31 +123,31 @@ describe DruidTools::Druid do
       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' }
@@ -159,7 +159,7 @@ describe DruidTools::Druid do
       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' }
@@ -208,48 +208,102 @@ describe DruidTools::Druid do
     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)      
+      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)      
+      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
-  
+
+  describe "#prune!" do
+
+    let(:workspace) { Dir.mktmpdir }
+
+    let(:dr1) { DruidTools::Druid.new @druid_1, workspace }
+    let(:dr2) { DruidTools::Druid.new @druid_2, workspace }
+    let(:pathname1) { dr1.pathname }
+
+    after(:each) do
+      FileUtils.remove_entry workspace
+    end
+
+    context "shared ancestor" do
+
+      before(:each) do
+        dr1.mkdir
+        dr2.mkdir
+        dr1.prune!
+      end
+
+      it "deletes the outermost directory" do
+        expect(File).to_not exist(dr1.path)
+      end
+
+      it "deletes empty ancestor directories" do
+        expect(File).to_not exist(pathname1.parent)
+        expect(File).to_not exist(pathname1.parent.parent)
+      end
+
+      it "stops at ancestor directories that have children" do
+        # 'cd/456' should still exist because of druid2
+        shared_ancestor = pathname1.parent.parent.parent
+        expect(shared_ancestor.to_s).to match(/cd\/456$/)
+        expect(File).to exist(shared_ancestor)
+      end
+    end
+
+    it "removes all directories up to the base path when there are no common ancestors" do
+      dr1.mkdir
+      dr1.prune!
+      expect(File).to_not exist(File.join(workspace, 'cd'))
+      expect(File).to exist(workspace)
+    end
+
+    it "removes directories with symlinks" do
+      source_dir = File.join workspace, 'src_dir'
+      FileUtils.mkdir_p(source_dir)
+      dr2.mkdir_with_final_link(source_dir)
+      dr2.prune!
+      expect(File).to_not exist(dr2.path)
+      expect(File).to_not exist(File.join(workspace, 'cd'))
+    end
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
 #$LOAD_PATH.unshift(File.expand_path('../../lib',__FILE__))
 
 require 'bundler/setup'
+Bundler.require(:default, :development)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: druid-tools
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,14 +10,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-11-07 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
@@ -25,7 +25,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 10.1.0
 - !ruby/object:Gem::Dependency
@@ -33,7 +33,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
@@ -41,9 +41,25 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: lyberteam-gems-devel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: Tools to manipulate DRUID trees and content directories
 email:
 - mbklein@stanford.edu
@@ -52,8 +68,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -91,9 +107,11 @@ files:
 - druid-tools.gemspec
 - lib/druid-tools.rb
 - lib/druid_tools.rb
+- lib/druid_tools/access_druid.rb
 - lib/druid_tools/druid.rb
 - lib/druid_tools/exceptions.rb
 - lib/druid_tools/version.rb
+- spec/access_druid_spec.rb
 - spec/druid_tools_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/sul-dlss/druid-tools
@@ -110,24 +128,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !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
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Tools to manipulate DRUID trees and content directories
 test_files:
+- spec/access_druid_spec.rb
 - spec/druid_tools_spec.rb
 - spec/spec_helper.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.8.7@druid-tools --create