druid-tools 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: cf9c519783ef2847427e51eaa3f35cb768d9406c
-  data.tar.gz: ae57ca611f4fc4edd01ddaa35d6a366697e715dc
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWYwNmM0OTExYjMwZDEyZTI4OTlmMGIzMGE5NzQ2NWY0NTlmNGVlOQ==
+  data.tar.gz: !binary |-
+    MDllNDUwYWUzMzJiZDUzZDUxZTA3NmQyYjFkMDQ1Y2FkMDQ3OWFhNg==
 SHA512:
-  metadata.gz: 2bbdd81ce14eb76a1c65d2b94b483dc69b7148ea197f49a28e3395f9682e61d179d220a81bd407562bf744c671a6c4101c7ea64c111cefa515f2a08972fe95e3
-  data.tar.gz: 75c06f9555897382202c5997571cfb4e15555e85a43deefba0702121e8392c33f7a5d7799d2a714c5d9397562ad651b1f4f3ad5553a1833b7209b6345234fdef
+  metadata.gz: !binary |-
+    YWQ4NzY4ODNiYWI3NjZmZTQ0MDE3NDQzYTE5OWNiMjJhZTk3N2Y0ZTlhM2U5
+    ZDI3NDc2NTU4NDNlOTBiMWRmOWFiNjM5NDAzNzBlOWY3NGU5MDI5NTU3ZmJk
+    NTgxMThjYTlmODU0NTJhYTBhNDYzZDk5NTg4ODU2NmNlNTZlZWU=
+  data.tar.gz: !binary |-
+    N2E4ODdiZGEwMzI1YTU5ODE5ZDA1MjIxMmVjNmNhODZmZmQ0YTE1ZGY4Yzhl
+    ODYwOTY3NWEwOTU1ZWE4NDcwYzdhODcwYTI1YzliMmRkZTNkNDFjMjE1ZmI2
+    YzAwYTdlZjJkNTA3NDQxM2QyMzRmZWJkNGEyYjUzNTRjNDZhNzA=

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.4.0

data/lib/druid_tools/druid.rb

@@ -1,7 +1,9 @@
 require 'pathname'
+require 'fileutils'
 
 module DruidTools
   class Druid
+    @@deletes_directory_name = '.deletes'
     attr_accessor :druid, :base
 
     class << self
@@ -136,16 +138,84 @@ module DruidTools
       parent = this_path.parent
       parent.rmtree if parent.exist? && parent != base_pathname
       prune_ancestors parent.parent
+      creates_delete_record 
     end
-
+    
+    #This function checks for existance of a .deletes dir one level into the path (ex: stacks/.deletes or purl/.deletes).  
+    #If the directory does not exist, it is created.  If the directory exists, check to see if the current druid has an entry there, if it does delete it.
+    #This is done because a file might be deleted, then republishing, then deleted we again, and we want to log the most recent delete.  
+    #
+    #@raises [Errno::EACCES] If write priveleges are denied
+    #
+    #@return [void] 
+    def prep_deletes_dir
+      #Check for existences of deletes dir 
+      create_deletes_dir if !deletes_dir_exists?
+      #In theory we could return true after this step (if it fires), since if there was no deletes dir then the file can't be present in the dir
+
+      #Check to see if this druid has been deleted before, meaning file currently exists 
+      deletes_delete_record if deletes_record_exists?
+    end
+    
+    #Provide the location for the .deletes directory in the tree
+    #
+    #@return [Pathname] the path to the directory, ex: "stacks/.deletes"
+    def deletes_dir_pathname
+      return Pathname(self.base.to_s + (File::SEPARATOR+@@deletes_directory_name))
+    end
+    
+    def deletes_record_pathname
+      return Pathname(deletes_dir_pathname.to_s + File::SEPARATOR + self.id)
+    end
+    
+    #Using the deletes directory path supplied by deletes_dir_pathname, this function determines if this directory exists 
+    #
+    #@return [Boolean] true if if exists, false if it does not
+    def deletes_dir_exists?
+      return File.directory?(deletes_dir_pathname) 
+    end
+    
+    def deletes_record_exists?
+      return File.exists?(deletes_dir_pathname.to_s + File::SEPARATOR + self.id)
+    end
+    
+    #Creates the deletes dir using the path supplied by deletes_dir_pathname
+    #
+    #@raises [Errno::EACCES] If write priveleges are denied
+    #
+    #@return [void]
+    def create_deletes_dir
+      FileUtils::mkdir_p deletes_dir_pathname
+    end
+    
+    #Deletes the delete record if it currently exists.  This is done to change the filed created, not just last modified time, on the system
+    #
+    #@raises [Errno::EACCES] If write priveleges are denied
+    #
+    #return [void]
+    def deletes_delete_record
+      FileUtils.rm(deletes_record_pathname) if deletes_record_exists? #thrown in to prevent an  Errno::ENOENT if you call this on something without a delete record
+    end
+    
+    #Creates an empty (pointer) file using the object's id in the .deletes dir
+    #
+    #@raises [Errno::EACCES] If write priveleges are denied
+    #
+    #@return [void]
+    def creates_delete_record
+      prep_deletes_dir
+      FileUtils.touch(deletes_record_pathname)
+    end
+    
     # @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.exist? && outermost_branch.children.size == 0
+      while outermost_branch.children.size == 0
         outermost_branch.rmdir
         outermost_branch = outermost_branch.parent
         break if  outermost_branch == base_pathname
       end
+    rescue
     end
 
   end

data/spec/druid_tools_spec.rb

@@ -16,7 +16,7 @@ describe DruidTools::Druid do
     FileUtils.rm_rf(File.join(@fixture_dir,'cd'))
   end
 
-  it "should be able to validate druid strings using the valid? class method" do
+  it "validate druid strings using the valid? class method" do
     tests = [
       # Expected     Input druid
       [true,         'druid:aa000bb0001'],
@@ -44,28 +44,28 @@ describe DruidTools::Druid do
     end
   end
 
-  it "should provide the full druid including the prefix" do
+  it "provides 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
+  it "extracts 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
+  it "raises 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
+  it "builds 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
+  it "creates and destroys druid directories" do
     File.exists?(@tree_1).should eq false
     File.exists?(@tree_2).should eq false
 
@@ -99,7 +99,7 @@ describe DruidTools::Druid do
       DruidTools::Druid.prefix = 'druid'
     end
 
-    it "should handle alternate prefixes" do
+    it "handles 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'
@@ -107,7 +107,7 @@ describe DruidTools::Druid do
   end
 
   describe "content directories" do
-    it "should know where its content goes" do
+    it "knows 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')
@@ -118,7 +118,7 @@ describe DruidTools::Druid do
       File.exists?(File.join(@tree_1,'temp')).should eq false
     end
 
-    it "should create its content directories on the fly" do
+    it "creates 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')
@@ -129,7 +129,7 @@ describe DruidTools::Druid do
       File.exists?(File.join(@tree_1,'temp')).should eq true
     end
 
-    it "should match glob" do
+    it "matches 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
@@ -142,37 +142,37 @@ describe DruidTools::Druid do
       @filelist = %w(1 2 3 4).collect { |num| "someFile#{num}" }
     end
 
-    it "should find content in content directories" do
+    it "finds 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
+    it "finds 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
+    it "finds 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
+    it "does 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
+    it "does 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
+    it "finds 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}" }
@@ -180,7 +180,7 @@ describe DruidTools::Druid do
       @druid.find_filelist_parent('content',@filelist).should == location
     end
 
-    it "should find a filelist in the root directory" do
+    it "finds 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}" }
@@ -188,7 +188,7 @@ describe DruidTools::Druid do
       @druid.find_filelist_parent('content',@filelist).should == location
     end
 
-    it "should find a filelist in the leaf directory" do
+    it "finds 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}" }
@@ -196,12 +196,12 @@ describe DruidTools::Druid do
       @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
+    it "raises 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
+    it "raises 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/)
@@ -240,7 +240,7 @@ describe DruidTools::Druid do
       File.readlink(@tree_2).should == @source_dir
     end
 
-    it "should not error out if the link to source already exists" do
+    it "does 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
@@ -250,6 +250,8 @@ describe DruidTools::Druid do
       @dr.mkdir(@fixture_dir)
       lambda { @dr.mkdir_with_final_link(@source_di) }.should raise_error(DruidTools::DifferentContentExistsError)
     end
+    
+    
   end
 
   describe "#prune!" do
@@ -259,7 +261,8 @@ describe DruidTools::Druid do
     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
@@ -267,6 +270,8 @@ describe DruidTools::Druid do
     context "shared ancestor" do
 
       before(:each) do
+        #Nil the create records for this context because we're in a known read only one
+        
         dr1.mkdir
         dr2.mkdir
         dr1.prune!
@@ -290,20 +295,123 @@ describe DruidTools::Druid do
     end
 
     it "removes all directories up to the base path when there are no common ancestors" do
+      #Make sure a delete record is not present
+      expect(dr1.deletes_record_exists?).to be_falsey
+      
+      #Nil the create records for this test 
       dr1.mkdir
       dr1.prune!
       expect(File).to_not exist(File.join(workspace, 'cd'))
       expect(File).to exist(workspace)
+      
+      #Make sure a delete record was created
+      expect(dr1.deletes_dir_exists?).to be_truthy
+      expect(dr1.deletes_record_exists?).to be_truthy
     end
 
     it "removes directories with symlinks" do
+      #Make sure a delete record is not present
+      expect(dr2.deletes_record_exists?).to be_falsey
+      
+      #Nil the create records for this test 
       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'))
+      
+      #Make sure a delete record was created
+      expect(dr2.deletes_dir_exists?).to be_truthy
+      expect(dr2.deletes_record_exists?).to be_truthy
+    end
+    
+    describe "logging deleted druids" do
+      
+            #Purge any paths or delete records created in the test
+            after :each do
+              #Remove the .deletes dir to clean up
+              dr2.deletes_delete_record if dr2.deletes_record_exists?
+              FileUtils.rm_rf dr2.deletes_dir_pathname
+              
+            end
+      
+            it "returns the path to the .deletes directory as a Pathname" do
+              expect(dr2.deletes_dir_pathname.class).to eq(Pathname)
+            end
+            
+            it "returns the path to the delete record for a druid as a Pathname" do
+              expect(dr2.deletes_record_pathname.class).to eq(Pathname)
+            end
+            
+            it "returns the path to the delete record for a druid as top_level/.deletes/druid" do
+               expect(dr2.deletes_record_pathname.to_s).to eq("#{dr2.base}/.deletes/#{dr2.id}")
+            end
+      
+            it "returns false when the .deletes dir is not present on the file system" do
+              expect(dr2.deletes_dir_exists?).to be_falsey 
+            end
+      
+            it "creates the .deletes dir and detect it exists" do
+      
+              #Clean the .deletes dir if present
+              FileUtils.rm_rf dr2.deletes_dir_pathname
+        
+              #Test for exists? and create
+              expect(dr2.deletes_dir_exists?).to be_falsey 
+              dr2.create_deletes_dir
+              expect(dr2.deletes_dir_exists?).to be_truthy
+            end
+      
+            it "returns false when the .deletes dir does not have a deleted record for a druid" do
+              expect(dr2.deletes_record_exists?).to be_falsey
+            end
+            
+            it "creates a deleted record with a parent directory that has no .deletes directory and no deleted for the file and successfully create a delete record there" do
+              #Expect there not to be a .deletes dir or file (the file expectation is redundant I know)
+              expect(dr2.deletes_dir_exists?).to be_falsey 
+              expect(dr2.deletes_record_exists?).to be_falsey
+              
+              #Create the delete record
+              dr2.creates_delete_record
+              
+              #Check to ensure items were created
+              expect(dr2.deletes_dir_exists?).to be_truthy
+              expect(dr2.deletes_record_exists?).to be_truthy
+            end
+            
+            it "creates a delete record with a parent directory that has a .deletes directory that does not contain a delete record for this druid" do
+              #Expect there not to be a .deletes dir or file (the file expectation is redundant I know)
+              expect(dr2.deletes_dir_exists?).to be_falsey 
+              expect(dr2.deletes_record_exists?).to be_falsey
+              
+              #Creates the deletes dir and check
+              dr2.create_deletes_dir
+              expect(dr2.deletes_dir_exists?).to be_truthy
+              expect(dr2.deletes_record_exists?).to be_falsey
+              
+              #Create the delete record
+              dr2.creates_delete_record
+              
+              #Check to ensure items were created
+              expect(dr2.deletes_dir_exists?).to be_truthy
+              expect(dr2.deletes_record_exists?).to be_truthy
+            end
+            
+            it "creates a delete record with a parent directory that does not have a .deletes directory and contains an older delete record" do
+              #Expect there not to be a .deletes dir or file (the file expectation is redundant I know)
+              expect(dr2.deletes_dir_exists?).to be_falsey 
+              expect(dr2.deletes_record_exists?).to be_falsey
+              
+              dr2.creates_delete_record
+              time = Time.now
+              expect(File.mtime(dr2.deletes_record_pathname)).to be <= time
+              sleep(1) #force a one second pause in case the machine is fast (as in not some old Commodore64), since mtime only goes down to the second
+              
+              dr2.creates_delete_record
+              #Should have a new newer deleted record
+              expect(File.mtime(dr2.deletes_record_pathname)).to be > time
+            end
     end
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: druid-tools
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Michael Klein
@@ -9,34 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-18 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Tools to manipulate DRUID trees and content directories
@@ -46,7 +46,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE
 - README.md
@@ -103,17 +103,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.1.2
 signing_key: 
 specification_version: 4
 summary: Tools to manipulate DRUID trees and content directories