Deprecate rmdir, prune! and prune_ancestors

Gemfile

@@ -3,11 +3,7 @@
 source 'https://rubygems.org'
 
 group :development do
-  gem 'debugger', platform: :ruby_19
-  gem 'pry-debugger', platform: :ruby_19
-  gem 'rcov', platform: :ruby_18
-  gem 'ruby-debug', platform: :ruby_18
-  gem 'simplecov', platform: %i[ruby_19 ruby_20]
+  gem 'byebug'
 end
 
 gemspec

druid-tools.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = File.read('VERSION').strip
 
+  gem.add_dependency 'deprecation'
   gem.add_development_dependency 'coveralls'
   gem.add_development_dependency 'rake', '>= 10.1.0'
   gem.add_development_dependency 'rspec', '~> 3.0'

lib/druid_tools/druid.rb

@@ -2,9 +2,13 @@
 
 require 'pathname'
 require 'fileutils'
+require 'deprecation'
 
 module DruidTools
   class Druid
+    extend Deprecation
+    self.deprecation_horizon = 'druid-tools 3.0.0'
+
     attr_accessor :druid, :base
 
     # See https://consul.stanford.edu/pages/viewpage.action?title=SURI+2.0+Specification&spaceKey=chimera
@@ -122,6 +126,7 @@ def mkdir_with_final_link(source, extra = nil)
       FileUtils.mkdir_p(real_path)
       FileUtils.ln_s(source, new_path, force: true)
     end
+    deprecation_deprecate :mkdir_with_final_link
 
     def rmdir(extra = nil)
       parts = tree
@@ -137,6 +142,7 @@ def rmdir(extra = nil)
         parts.pop
       end
     end
+    deprecation_deprecate :rmdir
 
     def pathname
       Pathname path
@@ -152,6 +158,7 @@ def prune!
       parent.rmtree if parent.exist? && parent != base_pathname
       prune_ancestors parent.parent
     end
+    deprecation_deprecate :prune!
 
     # @param [Pathname] outermost_branch The branch at which pruning begins
     # @return [void] Ascend the druid tree and prune empty branches
@@ -162,5 +169,6 @@ def prune_ancestors(outermost_branch)
         break if outermost_branch == base_pathname
       end
     end
+    deprecation_deprecate :prune_ancestors
   end
 end

spec/druid_tools_spec.rb

@@ -110,6 +110,7 @@
   end
 
   it '#mkdir, #rmdir create and destroy druid directories' do
+    allow(Deprecation).to receive(:warn)
     expect(File.exist?(tree1)).to eq false
     expect(File.exist?(tree2)).to eq false
 
@@ -259,6 +260,10 @@
   end
 
   describe '#mkdir error handling' do
+    before do
+      allow(Deprecation).to receive(:warn)
+    end
+
     it 'raises SameContentExistsError if the directory already exists' do
       druid_obj = described_class.new(strictly_valid_druid_str, fixture_dir)
       druid_obj.mkdir
@@ -279,6 +284,7 @@
     let(:druid_obj) { described_class.new(strictly_valid_druid_str, fixture_dir) }
 
     before do
+      allow(Deprecation).to receive(:warn)
       FileUtils.mkdir_p(source_dir)
     end
 
@@ -306,6 +312,10 @@
     let(:dr2) { described_class.new(strictly_valid_druid_str, workspace) }
     let(:pathname1) { dr1.pathname }
 
+    before do
+      allow(Deprecation).to receive(:warn)
+    end
+
     after do
       FileUtils.remove_entry workspace
     end