cul-preservation_utils 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e40bd6ef52afe2b4a3e501191ba1da9a63b984c1c192f59f79fbd88f502c7171
+  data.tar.gz: 8b8057c5e56fc06c1e8540b599975e8e10927a9ea823505b1d74c9462662afbf
+SHA512:
+  metadata.gz: 89f2499f64cd91e9c7acfc1e417466b7947d770b3874d1ee745d775da185f1fbe477a32a27882b3321114b702666fcae33ee352b4c6561d325d342e777b8821e
+  data.tar.gz: 3ffdd1f6ab8e17f84edd968c24ab6bb564038e7bc422e96781b7f210b868797516581ecb275399c09b89aee123fa02097417d48485d7730b96fe549b83b2836e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  rubocul: rubocul_default.yml
+
+AllCops:
+  TargetRubyVersion: 3.1 # TODO change to lower ruby version (match folio client)?

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-05-01
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2025 The Trustees of Columbia University in the City of New York
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,35 @@
+# Cul::PreservationUtils
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cul/preservation_utils`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cul-preservation_utils.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/cul/preservation_utils/file_path.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'stringex'
+
+# Cul::PreservationUtils::FilePath
+# The Filepath module provides utilities for validating that file names and file paths do not
+# include any characters that may be problematic for preservation objects that
+# will be stored in Google or Amazon cloud services.
+# Additionally, this has the benefit of having matching names in both local
+# copies of such Preservation objects and copies stored on the cloud.
+module Cul
+  module PreservationUtils
+    module FilePath
+      # The following code was taken from the ATC app's Atc::Utils::ObjectKeyNameUtils module
+      # Credit to fcd1
+
+      # About Cloud Storage objects: https://cloud.google.com/storage/docs/objects
+      # According to the above (and quite probably most Google Cloud Storage documentation),
+      # objects have names
+      # AWS - Creating object key names:
+      # https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html
+      # As seen in the title for the above page, an object in AWS S3 has a key name (or key)
+
+      DISALLOWED_ASCII_REGEX = '[^-a-zA-Z0-9_.()]'
+
+      def self.valid_file_path?(path_filename)
+        return false if ['', '.', '..', '/'].include? path_filename
+
+        pathname = Pathname.new(path_filename)
+
+        # a relative path is invalid
+        # todo : doesn't this code do the opposite of that?
+        return false if pathname.absolute?
+
+        path_to_file, filename = pathname.split
+
+        # validate filename
+        return false if filename.to_s.end_with?('.') || /#{DISALLOWED_ASCII_REGEX}/.match?(filename.to_s)
+        # if the valid filename is at the top level, return true
+        return true if pathname == pathname.basename
+
+        # check each component in the path to the file
+        path_to_file.each_filename do |path_segment|
+          return false if /#{DISALLOWED_ASCII_REGEX}/.match? path_segment
+        end
+        true
+      end
+
+      def self.remediate_file_path(filepath, unavailable_file_paths = []) # rubocop:disable Metrics/AbcSize
+        return filepath if !unavailable_file_paths.include?(filepath) && self.valid_file_path?(filepath)
+
+        self.argument_check(filepath)
+
+        pathname = Pathname.new(filepath)
+
+        remediated_pathname = Pathname.new('')
+        path_to_file, filename = pathname.split
+
+        filename_valid_ascii =
+          Stringex::Unidecoder.decode(filename.to_s).gsub(/#{DISALLOWED_ASCII_REGEX}/, '_').gsub(/\.$/, '_')
+
+        remediated_key_name = self.remediate_path(path_to_file, remediated_pathname).join(filename_valid_ascii).to_s
+
+        # no collisions
+        return remediated_key_name unless unavailable_file_paths.include? remediated_key_name
+
+        # handle collisions
+        self.handle_collision(remediated_key_name, unavailable_file_paths)
+      end
+
+      def self.argument_check(filepath_key)
+        raise ArgumentError, "Bad argument: '#{filepath_key}'" if ['', '.', '..', '/'].include? filepath_key
+        raise ArgumentError, 'Bad argument: absolute path' if filepath_key.start_with?('/')
+      end
+
+      def self.remediate_path(path_to_file, remediated_pathname)
+        # remediate each component in the path to the file
+        path_to_file.each_filename do |path_segment|
+          remediated_path_segment = Stringex::Unidecoder.decode(path_segment).gsub(/#{DISALLOWED_ASCII_REGEX}/, '_')
+          remediated_pathname += remediated_path_segment
+        end
+        remediated_pathname
+      end
+
+      def self.handle_collision(remediated_file_path, unavailable_file_path)
+        pathname = Pathname.new(remediated_file_path)
+        base = pathname.to_s.delete_suffix(pathname.extname)
+        new_remediated_file_path = "#{base}_1#{pathname.extname}"
+        suffix_num = 1
+        while unavailable_file_path.include? new_remediated_file_path
+          suffix_num += 1
+          new_remediated_file_path = "#{base}_#{suffix_num}#{pathname.extname}"
+        end
+        new_remediated_file_path
+      end
+    end
+  end
+end

data/lib/cul/preservation_utils/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cul
+  module PreservationUtils
+    VERSION = '0.1.4'
+  end
+end

data/lib/cul/preservation_utils.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# require_relative 'preservation_utils/file_path'
+require_relative 'preservation_utils/file_path'
+
+module Cul
+  module PreservationUtils
+    class Error < StandardError; end
+    # PreservationUtilities is implemented through submodules:
+    # Cul::PreservationUtils::FilePath
+    #   - See /lib/cul/preservation_utils/file_path.rb
+  end
+end

data/sig/cul/preservation_utils.rbs

@@ -0,0 +1,6 @@
+module Cul
+  module PreservationUtils
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: cul-preservation_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Bradley Goldsmith
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stringex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.6
+description: PreservationUtils provides the FilePath module for standardizing filepaths
+  for objects used in our Preservation services.
+email:
+- bg2918@columbia.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/cul/preservation_utils.rb
+- lib/cul/preservation_utils/file_path.rb
+- lib/cul/preservation_utils/version.rb
+- sig/cul/preservation_utils.rbs
+homepage: https://github.com/cul/cul-preservation_utils
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/cul/cul-preservation_utils
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Utilities related to Preservation workflows at Columbia University Library.
+test_files: []