filename_cleaner 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 807f37177fe0fae04a041ee3a85764c35535010d
-  data.tar.gz: e8d8cc7a7e5ed61e90e8c2fdbc190a2632a12471
+  metadata.gz: 35445207a901cb122ba596e958a996cd819bdebb
+  data.tar.gz: 69467588b5aba6e7996e76db86231f45ffc57aaf
 SHA512:
-  metadata.gz: 8ccfa992942ddc501f07270d555f90cdb6ab1af748f8be8275b6a06199fe86be8bdb636c73d302cef82eb344fa9f57e61e389feef75fdfc032ca54a7dd777a3d
-  data.tar.gz: 0b3f9519af19f1945900c3a5ed483d496d3c95b86736a8403d9b02034631654d91ca70a600d257d9aa1f94654d89a7fadb469248f86656ce42dda29c0098e194
+  metadata.gz: e41225111100cc8df68b16b19e9b6df8140ba91156cd0f27b5ba305225b35f264dbaa438543f5e0a311ed515e32506176735ef3531dae605a845a5a11da4784e
+  data.tar.gz: b342996a7c09770e73063a78b927989c05e393c048951ac726e3f18dd3e754d26fd3dce82cb37a235b3d69293dfa134d6d4cdda3eb27c3fc1baf446c42071cca

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.3.9
+
+* Make `formatted_name` public so that it can be re-used in other projects
+* Minor documentation cleanup
+
 ### 0.3.8
 
 * Simplify the CLI usage

data/README.md

@@ -19,6 +19,12 @@ Currently any string that are not one of letters (a..z, A..Z),
 numbers (0..9), _ (underscore), - (dash), and ' ' spaces string
 are first squeezed into one string and then replaced by any given string/char [default to . (a single dot)].
 
+Optionally, you could also
+
+- capitalized each word in the output
+- make each word in output lower case
+- use more than one character as the separator string if you prefer
+
 ### Installation
 
 ```sh

data/lib/filename_cleaner/cli.rb

@@ -78,7 +78,7 @@ Sanitize and rename file with special characters
           puts "FYI: process : #{index + 1} of #{files.size}"
           dirname  = File.dirname(File.expand_path(file))
           filename = File.basename(file)
-          new_name = formatted_name(filename, options)
+          new_name = FilenameCleaner.formatted_name(filename, options)
           old_name = File.expand_path(file)
           new_name = File.expand_path([dirname, new_name].join(File::SEPARATOR))
           compare_and_rename(old_name, new_name, options[:commit])
@@ -92,22 +92,6 @@ Sanitize and rename file with special characters
     end
     # rubocop:enable LineLength
 
-    def formatted_name(filename, options)
-      sep_char = options[:sep_char]
-      sanitized_name = FilenameCleaner.sanitize(filename, sep_char, true)
-
-      # First split the two part so that only name is used!
-      basename = File.basename(sanitized_name, ".*")
-      extname  = File.extname(sanitized_name)
-      if options[:downcase]
-        basename = basename.split(sep_char).map(&:downcase).join(sep_char)
-      end
-      if options[:capitalize]
-        basename= basename.split(sep_char).map(&:capitalize).join(sep_char)
-      end
-      "#{basename}#{extname}"
-    end
-
     def compare_and_rename(old_name, new_name, commit)
       if new_name != old_name
         puts "FYI: old name: #{old_name}"

data/lib/filename_cleaner/filename_cleaner.rb

@@ -1,10 +1,12 @@
 module FilenameCleaner
   DOT = "."
   class << self
-    # Sanitize the any name with or without any extension
+    # Sanitize the any name with or without extension
     #
     # @param [String] name the input string
     # @param [String] sep_char the separator char to be used
+    # @param [Boolean] have_extension indicate if the the input file should be
+    #                  treated as having extension or not having one
     # @return [String] output string with special chars replaced withe specified string
     def sanitize(name, sep_char = ".", have_extension = false)
       if have_extension
@@ -14,6 +16,30 @@ module FilenameCleaner
       end
     end
 
+    # Get formatted name for existing file
+    #
+    # @param [String] filename the input filename
+    # @param [Hash<Symbol, Object>] opts the hash value for options to be applied
+    #
+    # @option opts [String]  :sep_char The separator string
+    # @option opts [Boolean] :downcase Convert each word to lower case
+    # @option opts [Boolean] :capitalize: Capitalize each word in the name
+    def formatted_name(filename, opts = {})
+      sep_char = opts[:sep_char] || "."
+      sanitized_name = FilenameCleaner.sanitize(filename, sep_char, true)
+
+      # First split the two part so that only name is used!
+      basename = File.basename(sanitized_name, ".*")
+      extname  = File.extname(sanitized_name)
+      if opts[:downcase]
+        basename = basename.split(sep_char).map(&:downcase).join(sep_char)
+      end
+      if opts[:capitalize]
+        basename= basename.split(sep_char).map(&:capitalize).join(sep_char)
+      end
+      "#{basename}#{extname}"
+    end
+
   private
 
     # Sanitize the any name with or without any extension

data/lib/filename_cleaner/version.rb

@@ -1,3 +1,3 @@
 module FilenameCleaner
-  VERSION = "0.3.8"
+  VERSION = "0.3.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filename_cleaner
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-16 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor