zaru 0.0.1 → 0.0.2

data/lib/zaru.rb

@@ -3,6 +3,10 @@
 class Zaru
   CHARACTER_FILTER = /[\x00-\x1F\/\\:\*\?\"<>\|]/u
   UNICODE_WHITESPACE = /[[:space:]]+/u
+  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}
 
   def initialize(filename)
     @raw = filename.to_s.freeze
@@ -16,7 +20,8 @@ class Zaru
 
   # remove characters that aren't allowed cross-OS
   def sanitize
-    @sanitized ||= normalize.gsub(CHARACTER_FILTER,'')
+    @sanitized ||= 
+      filter_windows_reserved_names(normalize.gsub(CHARACTER_FILTER,''))
   end
 
   # normalize unicode string and cut off at 255 characters
@@ -32,6 +37,13 @@ class Zaru
   
   # convenience method
   def self.sanitize!(filename)
-    Zaru.new(filename).to_s
+    new(filename).to_s
   end
+  
+  private
+
+    def filter_windows_reserved_names(filename)
+      WINDOWS_RESERVED_NAMES.include?(filename.upcase) ? 'file' : filename
+    end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zaru
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,14 +11,16 @@ bindir: bin
 cert_chain: []
 date: 2013-02-03 00:00:00.000000000 Z
 dependencies: []
-description: Filename sanitization for Ruby
+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.
 email: thomas@slash7.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/zaru.rb
-homepage: http://rubygems.org/gems/zaru
+homepage: http://github.com/madrobby/zaru
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -41,5 +43,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: zaru
+summary: Filename sanitization for Ruby
 test_files: []