druid-tools 2.2.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae5225239dbe4cabc2b4380a386d476b73d9ae21af9f3791df9b1d44cb90f04e
-  data.tar.gz: 1a3274f2ba03e506cc1289715df194cbf8f6cf16b0d23a0367ee13ed0cae9e11
+  metadata.gz: 4e1cf67f6458c6ada6365aaa5efa859c9b145c95052c56a1dced7daa84b0a72a
+  data.tar.gz: f01aee261d0a590df682c1b2372a8d2c6bcd3c86ae1049ac28aef679130645f8
 SHA512:
-  metadata.gz: 25274f7e81d1694cbbef1419165dc517ca40ada672a9d4a76f9c8c38781a3782520992050ce2f056f6d954a9fd74adea1c5483b3f4297d7918c512697ab1148a
-  data.tar.gz: 259575663aa19d712b31aa5f62f4204b6779dae6deec8512a0fba5dcb98df50af8f44d7a51b2b5b88573fd51acf9716d46e2a9bdb2a354b50f379406166e609e
+  metadata.gz: 637824152edc8b881ff720d1813099856c34d97a55186706caf60e2074a0a6ab63fb97f883631d194ab628f7222d82977a9f06e2649eba0384267d70dc854221
+  data.tar.gz: f161e8cee7ef2efd112c351d87022a48f2e25b22dafd2d853d535e8bdb78712f3dbbf24730636a25aa3374d98a2a214143a62f8e69a02db482750958b6781792

data/.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  ruby-rails: sul-dlss/ruby-rails@3.0.1
+  ruby-rails: sul-dlss/ruby-rails@3.1.2
 workflows:
   build:
     jobs:

data/.gitignore

@@ -16,7 +16,6 @@ tmp
 .rvmrc
 .ruby-version
 .ruby-gemset
-Gemfile.lock
 .project
 doc
 .pry_history

data/.rubocop.yml

@@ -20,8 +20,6 @@ Naming/FileName:
     - druid-tools.gemspec
     - lib/druid-tools.rb
 
-Gemspec/DateAssignment: # new in 1.10
-  Enabled: true
 Gemspec/RequireMFA: # new in 1.23
   Enabled: true
 Layout/LineEndStringConcatenationIndentation: # new in 1.18
@@ -136,3 +134,33 @@ RSpec/FactoryBot/SyntaxMethods: # new in 2.7
   Enabled: true
 RSpec/Rails/AvoidSetupHook: # new in 2.4
   Enabled: true
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+RSpec/ChangeByZero: # new in 2.11.0
+  Enabled: true
+RSpec/VerifiedDoubleReference: # new in 2.10.0
+  Enabled: true

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    druid-tools (3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.32.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  druid-tools!
+  rake (>= 10.1.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+  simplecov
+
+BUNDLED WITH
+   2.3.17

data/README.md

@@ -71,8 +71,6 @@ d.mkdir
 d.mkdir('temp')
 # Remove a druid tree, but only up to the last shared branch directory
 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
@@ -110,19 +108,6 @@ d.find_content('this/file/does/not/exist.jpg')
 => nil
 ```
 
-### Pruning: removes leaves of tree up to non-empty branches
-
-```ruby
-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
 
 ```ruby

data/VERSION

@@ -1 +1 @@
-2.2.1
+3.0.0

data/druid-tools.gemspec

@@ -13,15 +13,14 @@ Gem::Specification.new do |gem|
 
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   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_dependency 'deprecation'
-  gem.add_development_dependency 'coveralls'
   gem.add_development_dependency 'rake', '>= 10.1.0'
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'rubocop-rake'
   gem.add_development_dependency 'rubocop-rspec'
+  gem.add_development_dependency 'simplecov'
 end

data/lib/druid_tools/druid.rb

@@ -2,13 +2,9 @@
 
 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
@@ -128,34 +124,6 @@ module DruidTools
       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
-    deprecation_deprecate :mkdir_with_final_link
-
-    def rmdir(extra = nil)
-      parts = tree
-      parts << extra unless extra.nil?
-      until parts.empty?
-        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
-    deprecation_deprecate :rmdir
-
     def pathname
       Pathname path
     end
@@ -167,22 +135,5 @@ module DruidTools
     def pruning_base
       pathname.parent
     end
-
-    def prune!
-      pruning_base.rmtree if pruning_base.exist? && pruning_base != base_pathname
-      prune_ancestors pruning_base.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
-    def prune_ancestors(outermost_branch)
-      while outermost_branch.exist? && outermost_branch.children.empty?
-        outermost_branch.rmdir
-        outermost_branch = outermost_branch.parent
-        break if outermost_branch == base_pathname
-      end
-    end
-    deprecation_deprecate :prune_ancestors
   end
 end

data/spec/druid_tools_spec.rb

@@ -119,8 +119,7 @@ RSpec.describe DruidTools::Druid do
     expect(druid.path).to eq(tree1)
   end
 
-  it '#mkdir creates, and #rmdir destroys, *only* the expected druid directory' do
-    allow(Deprecation).to receive(:warn)
+  it '#mkdir creates the expected druid directory' do
     expect(File.exist?(tree1)).to be false
     expect(File.exist?(tree2)).to be false
     expect(File.exist?(tree3)).to be false
@@ -143,22 +142,6 @@ RSpec.describe DruidTools::Druid do
     expect(File.exist?(tree1)).to be true
     expect(File.exist?(tree2)).to be true
     expect(File.exist?(tree3)).to be true
-
-    druid3.rmdir
-    expect(File.exist?(tree1)).to be true
-    expect(File.exist?(tree2)).to be true
-    expect(File.exist?(tree3)).to be false
-
-    druid2.rmdir
-    expect(File.exist?(tree1)).to be true
-    expect(File.exist?(tree2)).to be false
-    expect(File.exist?(tree3)).to be false
-
-    druid1.rmdir
-    expect(File.exist?(tree1)).to be false
-    expect(File.exist?(tree2)).to be false
-    expect(File.exist?(tree3)).to be false
-    expect(File.exist?(File.join(fixture_dir, 'cd'))).to be false
   end
 
   describe 'alternate prefixes' do
@@ -304,116 +287,4 @@ RSpec.describe DruidTools::Druid do
       expect { dr.mkdir }.to raise_error(DruidTools::DifferentContentExistsError)
     end
   end
-
-  describe '#mkdir_with_final_link' do
-    let(:source_dir) { '/tmp/content_dir' }
-    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
-
-    it 'creates a druid tree in the workspace with the final directory being a link to the passed in source' do
-      druid_obj.mkdir_with_final_link(source_dir)
-      expect(File).to be_symlink(druid_obj.path)
-      expect(File.readlink(tree2)).to eq(source_dir)
-    end
-
-    it 'does not error out if the link to source already exists' do
-      druid_obj.mkdir_with_final_link(source_dir)
-      expect(File).to be_symlink(druid_obj.path)
-      expect(File.readlink(tree2)).to eq(source_dir)
-    end
-
-    it 'raises DifferentContentExistsError if a directory already exists in the workspace for this druid' do
-      druid_obj.mkdir(fixture_dir)
-      expect { druid_obj.mkdir_with_final_link(source_dir) }.to raise_error(DruidTools::DifferentContentExistsError)
-    end
-  end
-
-  describe '#prune!' do
-    let(:workspace) { Dir.mktmpdir }
-    let(:dr1) { described_class.new(druid_str, workspace) }
-    let(:dr2) { described_class.new(strictly_valid_druid_str, workspace) }
-    let(:dr3) { DruidTools::AccessDruid.new(access_druid_str, workspace) }
-    let(:pathname1) { dr1.pathname }
-
-    before do
-      allow(Deprecation).to receive(:warn)
-    end
-
-    after do
-      FileUtils.remove_entry workspace
-    end
-
-    context 'with an access druid sharing the first three path segments' do
-      before do
-        # Nil the create records for this context because we're in a known read only one
-        dr1.mkdir
-        dr2.mkdir
-        dr3.mkdir
-        dr3.prune!
-      end
-
-      it 'deletes the outermost directory' do
-        expect(File).not_to exist(dr3.pruning_base)
-      end
-
-      it 'does not delete unrelated ancestor directories' do
-        expect(File).to exist(dr1.pruning_base)
-        expect(File).to exist(dr1.pruning_base.parent)
-      end
-
-      it 'stops at ancestor directories that have children' do
-        # 'cd/456/ef' should still exist because of dr1
-        shared_ancestor = dr1.pruning_base.parent
-        expect(shared_ancestor.to_s).to match(%r{cd/456/ef$})
-        expect(File).to exist(shared_ancestor)
-      end
-    end
-
-    context 'when there is a shared ancestor' do
-      before do
-        # Nil the create records for this context because we're in a known read only one
-        dr1.mkdir
-        dr2.mkdir
-        dr1.prune!
-      end
-
-      it 'deletes the outermost directory' do
-        expect(File).not_to exist(dr1.path)
-      end
-
-      it 'deletes empty ancestor directories' do
-        expect(File).not_to exist(pathname1.parent)
-        expect(File).not_to 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(%r{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
-      # Nil the create records for this test
-      dr1.mkdir
-      dr1.prune!
-      expect(File).not_to exist(File.join(workspace, 'cd'))
-      expect(File).to exist(workspace)
-    end
-
-    it 'removes directories with symlinks' do
-      # 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).not_to exist(dr2.path)
-      expect(File).not_to exist(File.join(workspace, 'cd'))
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -1,12 +1,7 @@
 # frozen_string_literal: true
 
-# $LOAD_PATH.unshift(File.expand_path('../../lib',__FILE__))
-
-require 'coveralls'
-Coveralls.wear_merged! # because we run travis on multiple rubies
-
 require 'simplecov'
-SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+require 'tmpdir' # Dir.mktmpdir
 SimpleCov.start do
   add_filter 'spec'
 end

metadata

@@ -1,74 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: druid-tools
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Michael Klein
 - Darren Hardy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: deprecation
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 10.1.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,6 +109,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -129,7 +130,7 @@ licenses:
 - Stanford University Libraries
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,11 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Tools to manipulate DRUID trees and content directories
-test_files:
-- spec/druid_tools/purl_druid_spec.rb
-- spec/druid_tools_spec.rb
-- spec/spec_helper.rb
+test_files: []