cul-preservation_utils 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dfbaa551f914435a54b9867ab8b07840187004161d083083f0ca45e3fda950c
-  data.tar.gz: 1b3b1de9043ecb253ea8f1fe459091f9f88621be10ea422c4bd261ed287c0fc5
+  metadata.gz: 6726052ab3c57e5a2a4e2a3efad429007d1f53b76d0814a38041ec50991c0594
+  data.tar.gz: 3c2c35d368aaadaef863fbbbbf39f273a1feed861de69a69660a693cc787ff26
 SHA512:
-  metadata.gz: da904712c32a211ac4d68f12c1682dc3bd469d09715652ae4e1a05344629ab8bf97b620ee61773ef025a48afc07212f014f9e35817343c0a6bca39d9cc165d57
-  data.tar.gz: 1ee463fb8aabb68ce8b19590f4f9d0f88403832370702d2174071dd51cf828a20f18b52ced6b9db8d3c710ce354b438a20cae0ab2acda17739b58c2e1e6c084b
+  metadata.gz: 5efa81994783bd57cfdda961a3b36b7cac3bd7b9af8f3702bd78e4df48b54a6811bdc8e6cc98fb89eeb6dc617de3e879bf1b6ab58ebccc51ae0fbb936051fe0c
+  data.tar.gz: 7b2a2df9bc67d82d98c3f961b9736bc0ac3d27d9cd3383071fcdab278bc8f41d828c141d0848d42c5de9a28b7783a33e3ccd0f294b513ad3b8cca3c0607f8b85

data/README.md

@@ -1,28 +1,42 @@
 # Cul::PreservationUtils
 
-TODO: Delete this and the text below, and describe your gem
+A collection of modules with Utility Methods related to working with Preservation objects.
 
-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.
+Incudes:
+- **FilePath**: a module for standardizing filepaths for objects used in our Preservation services.
 
-## 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.
+(More modules will be added in the future)
 
-Install the gem and add to the application's Gemfile by executing:
+Preservation objects are put in cloud storage, either with Google Cloud or Amazon Web Services. Validation rules for object file paths were imlpemented based on the charactersets allowed in object names in Google Cloud and AWS.
 
+## Installation
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add cul/preservation_utils
 ```
 
 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
+gem install cul/preservation_utils
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+You can access the FilePath module via namespace constants:
+```
+require 'cul/preservaion_utils'
+
+# Determine if a file path is valid or not (invalid means it contains unsupported characters)
+
+test_file_path = 'top_dir/!a$b%c%/我能.我能'
+Cul::PreservationUtils::FilePath.valid_file_path?(test_file_path)
+#=> False
+
+# Remediate a file path
+
+remediated_file_path = Cul::PreservationUtils::FilePath.remediate(test_file_path)
+puts remediated_file_path #=> 'top_dir/_a_b_c_/Wo_Neng_.Wo_Neng_'
+```
 
 ## Development
 
@@ -32,4 +46,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cul-preservation_utils.
+Bug reports and pull requests are welcome on GitHub at https://github.com/cul/cul-preservation_utils.

data/lib/cul/preservation_utils/file_path.rb

@@ -24,7 +24,7 @@ module Cul
 
       DISALLOWED_ASCII_REGEX = '[^-a-zA-Z0-9_.()]'
 
-      def self.valid_file_path?(path_filename)
+      def valid_file_path?(path_filename)
         return false if ['', '.', '..', '/'].include? path_filename
 
         pathname = Pathname.new(path_filename)
@@ -47,10 +47,10 @@ module Cul
         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)
+      def remediate_file_path(filepath, unavailable_file_paths = []) # rubocop:disable Metrics/AbcSize
+        return filepath if !unavailable_file_paths.include?(filepath) && valid_file_path?(filepath)
 
-        self.argument_check(filepath)
+        argument_check(filepath)
 
         pathname = Pathname.new(filepath)
 
@@ -60,21 +60,21 @@ module Cul
         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
+        remediated_key_name = 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)
+        handle_collision(remediated_key_name, unavailable_file_paths)
       end
 
-      def self.argument_check(filepath_key)
+      def 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)
+      def 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}/, '_')
@@ -83,7 +83,7 @@ module Cul
         remediated_pathname
       end
 
-      def self.handle_collision(remediated_file_path, unavailable_file_path)
+      def 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}"

data/lib/cul/preservation_utils/version.rb

@@ -2,6 +2,6 @@
 
 module Cul
   module PreservationUtils
-    VERSION = '0.1.6'
+    VERSION = '0.1.7'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cul-preservation_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Bradley Goldsmith
@@ -10,39 +10,39 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: stringex
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.8.6
+        version: 0.1.0
   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
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: ostruct
+  name: stringex
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        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: 0.1.0
+        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: