zaru 1.0.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dce46aeee751c80d068262090dd9ff1d999c9d3e938c4624b5d46c1b7017533
-  data.tar.gz: dc5e1bd34144d17b88ea6b0d8a60c832cbde857478f9f853fc1b17e5e1ae5d9c
+  metadata.gz: 563b71271ed8169cd299499ef243e937f5fd3a04055377db87c0d821973a839e
+  data.tar.gz: a8f51824ca7a18598770f9a2a63c254565fe47ed4f616f87bcdd8c9e6d5f0201
 SHA512:
-  metadata.gz: 7fa8e470ff88a19538b88caeb3b108211262c8dacfb23503269d4738339c9ab7a54a6d0d57b0598dc08de7cdbbbe99e0e352f3d394a131359270e4a86c89e230
-  data.tar.gz: 602c8a35db90b7cc934051b69b77382038f93ef3251d62934600b56a82454470ff3a7657c46622823e10b86b5e6567e206841f65a4539001572d0b930a703d9b
+  metadata.gz: f4b51ce4dc951a7ecbf2867b2554505ca0837392cee8e1f8b0bc26fcfebdffb6d787006c9764bd2b1d1e8ca9dd71a8ce9114459ba2ea783b6e0ecd0e16c0aeac
+  data.tar.gz: 9470144c2ca5b9a5eb79b030bad989ee0fa3d638a1572e38a1e69799a1da1dac1e8daaa65b2fe97aebadb126e50c528dfcc7890d243afd0a73e146c441f4f24e

data/lib/zaru.rb

@@ -1,12 +1,14 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
+# Zaru normalizes, sanitizes, and truncates filenames so they can be
+# safely used across Linux, macOS, and Windows.
 class Zaru
-  CHARACTER_FILTER = /[\x00-\x1F\/\\:\*\?\"<>\|]/u
-  UNICODE_WHITESPACE = /[[:space:]]+/u
+  CHARACTER_FILTER = %r{[\x00-\x1F/\\:*?"<>|]}u.freeze
+  UNICODE_WHITESPACE = /[[:space:]]+/u.freeze
   WINDOWS_RESERVED_NAMES =
-    %w{CON PRN AUX NUL COM1 COM2 COM3 COM4 COM5
-       COM6 COM7 COM8 COM9 LPT1 LPT2 LPT3 LPT4
-       LPT5 LPT6 LPT7 LPT8 LPT9}
+    %w[CON PRN AUX NUL COM1 COM2 COM3 COM4 COM5 COM6 COM7 COM8 COM9
+       COM COM² COM³ LPT1 LPT2 LPT3 LPT4 LPT5 LPT6 LPT7 LPT8 LPT9 LPT¹
+       LPT² LPT³].freeze
   FALLBACK_FILENAME = 'file'
 
   def initialize(filename, options = {})
@@ -18,7 +20,7 @@ class Zaru
   # strip whitespace on beginning and end
   # collapse intra-string whitespace into single spaces
   def normalize
-    @normalized ||= @raw.strip.gsub(UNICODE_WHITESPACE,' ')
+    @normalize ||= @raw.strip.gsub(UNICODE_WHITESPACE, ' ')
   end
 
   # remove bad things!
@@ -29,15 +31,16 @@ class Zaru
   #
   # this renormalizes after filtering in order to collapse whitespace
   def sanitize
-    @sanitized ||=
-      filter(normalize.gsub(CHARACTER_FILTER,'')).gsub(UNICODE_WHITESPACE,' ')
+    @sanitize ||=
+      filter(normalize.gsub(CHARACTER_FILTER, '')).gsub(UNICODE_WHITESPACE, ' ')
   end
 
   # cut off at 255 characters
   # optionally provide a padding, which is useful to
   # make sure there is room to add a file extension later
   def truncate
-    @truncated ||= sanitize.chars.to_a.slice(0..254-@padding).join
+    max_length = [254 - @padding, 0].max + 1
+    @truncate ||= sanitize.chars.to_a.slice(0...max_length).join
   end
 
   def to_s
@@ -51,24 +54,32 @@ class Zaru
 
   private
 
-    attr_reader :fallback
+  attr_reader :fallback
 
-    def filter(filename)
-      filename = filter_windows_reserved_names(filename)
-      filename = filter_blank(filename)
-      filename = filter_dot(filename)
-    end
+  def filter(filename)
+    filename = filter_windows_reserved_names(filename)
+    filename = filter_blank(filename)
+    filter_dot(filename)
+  end
 
-    def filter_windows_reserved_names(filename)
-      WINDOWS_RESERVED_NAMES.include?(filename.upcase) ? fallback : filename
-    end
+  def filter_windows_reserved_names(filename)
+    return '' if filename.empty?
 
-    def filter_blank(filename)
-      filename.empty?? fallback : filename
-    end
+    parts = filename.split('.').reject(&:empty?)
+    return '' if parts.empty?
 
-    def filter_dot(filename)
-      filename.start_with?('.')? "#{fallback}#{filename}" : filename
+    if WINDOWS_RESERVED_NAMES.include?(parts[0].upcase)
+      parts.fill(fallback, 0, 1).join('.')
+    else
+      filename
     end
+  end
+
+  def filter_blank(filename)
+    filename.empty? ? fallback : filename
+  end
 
+  def filter_dot(filename)
+    filename.start_with?('.') ? "#{fallback}#{filename}" : filename
+  end
 end

metadata

@@ -1,57 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaru
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: '1.1'
 platform: ruby
 authors:
 - Thomas Fuchs
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
 description: Zaru takes a given filename (a string) and normalizes, filters and truncates
   it, so it can be safely used as a filename in modern operating systems. Zaru doesn't
   remove Unicode characters when not necessary.
@@ -65,7 +22,6 @@ homepage: https://github.com/madrobby/zaru
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -73,15 +29,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Filename sanitization for Ruby
 test_files: []