filename_cleaner 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e4c0aad87875fbeee0976b1682cb3b2f30e0c3c
-  data.tar.gz: 8af35d698b9762048de68a92aa8af73d3e21a85e
+  metadata.gz: 5f6078a186a0c9e84d192701867662ad2ce071bd
+  data.tar.gz: 43354655bc00fcb28cd45bd232a6c7eeb2ac82e8
 SHA512:
-  metadata.gz: 894666704a1dfe9bdfbe320ac027cc6873ef65fa5e81bb13380f2894df2084027895b623fdf69bc34b7fa1d30e4e80281714a2e2eac541e08ff29872cadaebdc
-  data.tar.gz: 4ff5423c8deb7ce03ed0ff9728d812155e3be8e80aef7d6b27454c6e0cd3294e4a7ec095c30fcdc532bc20fc3ac4d0e55c559b624c34a4d32e5453faac70c5f1
+  metadata.gz: 7bc0cf808b4f785de98469185023e17b5cab828f58d7369a16429bd76897e397a41925f746093a1ef207c4184cf635859af47dfa9ca902024756a4b25c016ed9
+  data.tar.gz: 2f60628983d6bef4f9e6df80c8eac533a07181b335807d52f6b0fc211a02a86d1455a67be19422b67343b73e799946379a9293de4ba589c5c6102175d19964bc

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2

data/CHANGELOGS.md

@@ -1,11 +1,17 @@
 ### Changelogs
 
+#### 0.3.0
+
+- Cleanup and simplify the apis
+- Rename `--dry-run` to `--commit`
+- Remove the `--non-exts` options to only support file with extension
+
 #### 0.2.0
 
 - Cleanup the APIs
   * rename `sanitize_filename` to `sanitize_name_with_extension`
-  * add `sanitize_name`
-- Don't check for extension if we are dealing with a directory name
+  * add `sanitize_name` for name that does not have any extension
+- Make non-public apis private
 - Add core_ext/object/blank.rb
 
 #### 0.1.1

data/README.md

@@ -1,11 +1,17 @@
 ## filename_cleaner
 
-[![Gem Version](https://badge.fury.io/rb/filename_cleaner.svg)](http://badge.fury.io/rb/filename_cleaner)
-[![Dependency Status](https://gemnasium.com/agilecreativity/filename_cleaner.png)](https://gemnasium.com/agilecreativity/filename_cleaner)
-[![Code Climate](https://codeclimate.com/github/agilecreativity/filename_cleaner.png)](https://codeclimate.com/github/agilecreativity/filename_cleaner)
+[![Gem Version](https://badge.fury.io/rb/filename_cleaner.svg)][gem]
+[![Dependency Status](https://gemnasium.com/agilecreativity/filename_cleaner.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/agilecreativity/filename_cleaner.png)][codeclimate]
+[![Build Status](https://secure.travis-ci.org/agilecreativity/filename_cleaner.png)][travis-ci]
 
-Quickly rename list of files (with or without extensions) and replace any special characters with
-a specific valid string (or separator char).
+[gem]: http://badge.fury.io/rb/filename_cleaner
+[gemnasium]: https://gemnasium.com/agilecreativity/filename_cleaner
+[codeclimate]: https://codeclimate.com/github/agilecreativity/filename_cleaner
+[travis-ci]: http://travis-ci.org/agilecreativity/filename_cleaner
+
+Quickly rename list of files with extension and replace any special characters with
+with any given string.
 
 Currently any string that are not one of letters (a..z, A..Z),
 numbers (0..9), _ (underscore), - (dash), and ' ' spaces string
@@ -23,13 +29,12 @@ Just type `filename_cleaner` without any options to see the list of help
 
 ```
 Usage:
-  filename_cleaner clean
+  filename_cleaner rename
 
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory
                                            # Default: . (current directory)
   -e, [--exts=one two three]               # List of extensions to search for
-  -f, [--non-exts=one two three]           # List of files without extension to search for
   -n, [--inc-words=one two three]          # List of words to be included in the result if any
   -x, [--exc-words=one two three]          # List of words to be excluded from the result if any
   -i, [--ignore-case], [--no-ignore-case]  # Match case insensitively
@@ -39,24 +44,23 @@ Options:
   -v, [--version], [--no-version]          # Display version information
   -s, [--sep-char=SEP_CHAR]                # Separator char to use
                                            # Default: .
-  -d, [--dry-run], [--no-dry-run]          # Perform a dry run only
-                                           # Default: true
+  -c, [--commit], [--no-commit]            # Commit your changes
 
-Sanitize filename
+Sanitize and rename file with special characters
 ```
 
 To perform the dry-run without make any changes to the file system:
 
 ```
 cd ~/projects/files
-filename_cleaner clean --base-dir . --extes java rb --recursive --sep-char '_'
+filename_cleaner rename --base-dir . --exts java rb --recursive --sep-char _
 ```
 
 To make your change permanent:
 
 ```
 cd ~/projects/files
-filename_cleaner clean --base-dir . --extes java rb --recursive --sep-char '_' --no-dry-run
+filename_cleaner rename --base-dir . --exts java rb --recursive --sep-char _ --commit
 ```
 
 #### Us as library in your project
@@ -80,12 +84,12 @@ Example Usage:
 ```ruby
 require 'filename_cleaner'
 # work with the file that have extension
-clean_name = FilenameCleaner::sanitize_name_with_extension('some b@d fil$name.txt', '_')
-puts clean_name # => 'some_b_d_fil_name.txt'
+new_name = FilenameCleaner.sanitize_name_with_extension('some b@d fil$name.txt', '_')
+puts new_name # => 'some_b_d_fil_name.txt'
 
 # or to work with the file without extension
-clean_name = FilenameCleaner::sanitize_name('some b@d fil$name.txt', '_')
-puts clean_name # => 'some_b_d_fil_name_txt'
+new_name = FilenameCleaner.sanitize_name('some b@d fil$name.txt', '_')
+puts new_name # => 'some_b_d_fil_name_txt'
 ```
 
 ### Contributing
@@ -99,5 +103,4 @@ GitHub pull requests are even better!.
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-[agile_utils]: https://rubygems.org/gems/agile_utils
 [rubocop]: https://github.com/bbatsov/rubocop

data/lib/filename_cleaner/cli.rb

@@ -2,13 +2,11 @@ require 'thor'
 require 'agile_utils'
 require 'fileutils'
 require_relative '../filename_cleaner'
-
 module FilenameCleaner
   class CLI < Thor
-    desc 'clean', 'Remove special characters in the list of files'
+    desc 'rename', 'Sanitize and rename file with special characters'
     method_option *AgileUtils::Options::BASE_DIR
     method_option *AgileUtils::Options::EXTS
-    method_option *AgileUtils::Options::NON_EXTS
     method_option *AgileUtils::Options::INC_WORDS
     method_option *AgileUtils::Options::EXC_WORDS
     method_option *AgileUtils::Options::IGNORE_CASE
@@ -20,31 +18,30 @@ module FilenameCleaner
                   desc: 'Separator char to use',
                   default: '.'
 
-    method_option :dry_run,
+    method_option :commit,
                   type: :boolean,
-                  aliases: '-d',
-                  desc: 'Perform a dry run only',
-                  default: true
-    def clean
+                  aliases: '-c',
+                  desc: 'Commit your changes',
+                  default: false
+    def rename
       opts = options.symbolize_keys
       if opts[:version]
         puts "You are using Filename Cleaner version #{FilenameCleaner::VERSION}"
         exit
       end
-      run(opts)
+      sanitize_and_rename(opts)
     end
 
     desc 'usage', 'Display help screen'
     def usage
       puts <<-EOS
 Usage:
-  filename_cleaner clean [OPTIONS]
+  filename_cleaner rename
 
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory
-                                           # Default: . (current directory)
+                                           # Default: . (current directory name)
   -e, [--exts=one two three]               # List of extensions to search for
-  -f, [--non-exts=one two three]           # List of files without extension to search for
   -n, [--inc-words=one two three]          # List of words to be included in the result if any
   -x, [--exc-words=one two three]          # List of words to be excluded from the result if any
   -i, [--ignore-case], [--no-ignore-case]  # Match case insensitively
@@ -54,8 +51,9 @@ Options:
   -v, [--version], [--no-version]          # Display version information
   -s, [--sep-char=SEP_CHAR]                # Separator char to use
                                            # Default: .
-  -d, [--dry-run], [--no-dry-run]          # Perform a dry run only
-                                           # Default: true
+  -c, [--commit], [--no-commit]            # Commit your changes
+
+Sanitize and rename file with special characters
       EOS
     end
 
@@ -63,8 +61,8 @@ Options:
 
     private
 
-    def run(options = {})
-      files = CodeLister.files(options || [])
+    def sanitize_and_rename(options = {})
+      files = CodeLister.files(options)
       if files.empty?
         puts "No match found for your options :#{options}"
       else
@@ -72,22 +70,21 @@ Options:
           puts "FYI: process : #{index + 1} of #{files.size}"
           dirname  = File.dirname(File.expand_path(file))
           filename = File.basename(file)
-          sanitized_name = FilenameCleaner::sanitize_name_with_extension(filename, options[:sep_char])
+          sanitized_name = FilenameCleaner::sanitize(filename, options[:sep_char], true)
           old_name = File.expand_path(file)
           new_name = File.expand_path([dirname, sanitized_name].join(File::SEPARATOR))
-
-          if !options[:dry_run]
-            if new_name != old_name
-              puts "FYI: old name: #{old_name}"
-              puts "FYI: new name: #{new_name}"
+          if new_name != old_name
+            puts "FYI: old name: #{old_name}"
+            puts "FYI: new name: #{new_name}"
+            if options[:commit]
               FileUtils.mv old_name, new_name
-            else
-              puts "FYI: same file #{old_name}"
             end
           else
-            puts 'No changes will be applied as this is a dry-run'
+            puts "FYI: same file #{old_name}"
           end
-
+        end
+        unless options[:commit]
+          puts 'No changes will take place as this is a dry run, to commit your change, please use  --commit option'
         end
       end
     end

data/lib/filename_cleaner/filename_cleaner.rb

@@ -1,25 +1,43 @@
 module FilenameCleaner
   DOT = '.'
   class << self
-    # Sanitize the name without any extension
-    def sanitize_name(name, sep_char = '.')
-      replace_dot!(sanitize_with_dot(name), sep_char)
-    end
 
-    # Sanitize filename that have the extension
+    # Sanitize the any name with or without any extension
     #
-    # @param [String] filename the input filename with extension
-    # @return [String] the output file with special characters replaced.
-    def sanitize_name_with_extension(filename, sep_char = '.')
-      extension = File.extname(filename)
-      name_only = File.basename(filename, ".*")
-      name_only = replace_dot!(sanitize_with_dot(name_only), sep_char)
-      "#{name_only}#{extension}"
+    # @param [String] name the input string
+    # @param [String] sep_char the separator char to be used
+    # @return [String] output string with special chars replaced withe specified string
+    def sanitize(name, sep_char = '.', have_extension = false)
+      if have_extension
+        sanitize_name_with_extension(name, sep_char)
+      else
+        sanitize_name_without_extension(name, sep_char)
+      end
     end
 
     private
 
-    # Replace the multipe special characters with a dot
+    # Sanitize the any name with or without any extension
+    #
+    # @param [String] name the input string
+    # @param [String] sep_char the separator char to be used
+    # @return [String] output string with special chars replaced withe specified string
+    def sanitize_name_without_extension(name, sep_char = '.')
+      replace_dot(sanitize_with_dot(name), sep_char)
+    end
+
+    # Sanitize filename that works with file with extension
+    #
+    # @param [String] name the input filename with extension
+    # @return [String] the output file with special characters replaced
+    def sanitize_name_with_extension(name, sep_char = '.')
+      extension = File.extname(name)
+      name_only = File.basename(name, ".*")
+      name_only = replace_dot(sanitize_with_dot(name_only), sep_char)
+      "#{name_only}#{extension}"
+    end
+
+    # Replace the multiple special characters with a dot string
     #
     # @param [String] name input file
     # @return [String] the new name with special characters replaced or removed.
@@ -43,7 +61,7 @@ module FilenameCleaner
     end
 
     # replace 'dot' string with a given string if specified
-    def replace_dot!(string, replace = nil)
+    def replace_dot(string, replace = nil)
       string.gsub!(/#{Regexp.quote(DOT)}+/, replace) if replace
       string
     end

data/lib/filename_cleaner/version.rb

@@ -1,3 +1,3 @@
 module FilenameCleaner
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/test/lib/filename_cleaner/test_filename_cleaner.rb

@@ -1,58 +1,66 @@
 require_relative '../../test_helper'
 describe FilenameCleaner do
-  # context '#sanitize_with_dot' do
-  #   it 'works with simple input' do
-  #     FilenameCleaner.sanitize_with_dot('any txt').must_equal 'any.txt'
-  #     FilenameCleaner.sanitize_with_dot('this is a long filename.txt').must_equal 'this.is.a.long.filename.txt'
-  #   end
-  #   it 'works with text with extension' do
-  #     FilenameCleaner.sanitize_with_dot('filename.txt').must_equal 'filename.txt'
-  #   end
-  #   it 'strips the end of string if not letters or numbers' do
-  #     FilenameCleaner.sanitize_with_dot('filename .txt').must_equal 'filename.txt'
-  #     FilenameCleaner.sanitize_with_dot('filename  .txt').must_equal 'filename.txt'
-  #     FilenameCleaner.sanitize_with_dot('filename   !.txt').must_equal 'filename.txt'
-  #   end
-  # end
-  context '#sanitize_name_with_extension' do
-    describe 'file with extension' do
-      it 'replaces mutilple consecutive chars with one' do
-        FilenameCleaner.sanitize_name_with_extension('some!!!$file$:%.txt').must_equal 'some.file.txt'
+  context '#sanitize' do
+    describe 'without extension' do
+      it 'works with simple input' do
+        FilenameCleaner.sanitize('any txt').must_equal 'any.txt'
+        FilenameCleaner.sanitize('any txt', '-').must_equal 'any-txt'
       end
-      it 'works with default separator' do
-        FilenameCleaner.sanitize_name_with_extension('some file.txt').must_equal 'some.file.txt'
+
+      it 'works with text containing the dot' do
+        FilenameCleaner.sanitize('text with a dot.txt').must_equal 'text.with.a.dot.txt'
+        FilenameCleaner.sanitize('text with a dot.txt', '_').must_equal 'text_with_a_dot_txt'
       end
-      it 'works with non-default separator' do
-        FilenameCleaner.sanitize_name_with_extension('some file.txt', '_').must_equal 'some_file.txt'
+      it 'replaces many consecutive special characters with one' do
+        FilenameCleaner.sanitize('text with!@**! multiple chars').must_equal 'text.with.multiple.chars'
+        FilenameCleaner.sanitize('text with!@**! multiple chars', '_').must_equal 'text_with_multiple_chars'
       end
-    end
-    describe 'file without extension' do
-      it 'replaces mutilple consecutive chars with one' do
-        FilenameCleaner.sanitize_name_with_extension('some!!!$file$:%.').must_equal 'some.file'
+      it 'strips all special characters at the end' do
+        FilenameCleaner.sanitize('filename .txt_').must_equal 'filename.txt'
+        FilenameCleaner.sanitize('filename .txt_!$#$#', '_').must_equal 'filename_txt'
       end
-      context 'using default separator' do
-        it 'works with simple input' do
-          FilenameCleaner.sanitize_name_with_extension('Gemfile').must_equal 'Gemfile'
+    end
+    describe 'with extension' do
+      context 'file with extension' do
+        it 'replaces mutilple consecutive chars with one' do
+          FilenameCleaner.sanitize('some!!!$file$:%.txt', '.', true).must_equal 'some.file.txt'
+        end
+        it 'works with default separator' do
+          FilenameCleaner.sanitize('some file.txt', '.', true).must_equal 'some.file.txt'
         end
-        it 'works with complex input' do
-          FilenameCleaner.sanitize_name_with_extension('File$without!extension').must_equal 'File.without.extension'
+        it 'works with non-default separator' do
+          FilenameCleaner.sanitize('some file.txt', '_', true).must_equal 'some_file.txt'
         end
       end
-      context 'with non-default separator char' do
-        it 'works with simple input' do
-          FilenameCleaner.sanitize_name_with_extension('Gemfile', '_').must_equal 'Gemfile'
+      context'file without extension' do
+        it 'replaces mutilple consecutive chars with one' do
+          FilenameCleaner.sanitize('some!!!$file$:%', '.', true).must_equal 'some.file'
         end
-        it 'works with complex input' do
-          FilenameCleaner.sanitize_name_with_extension('File$without!extension', '-').must_equal 'File-without-extension'
+        context 'using default separator' do
+          it 'works with simple input' do
+            FilenameCleaner.sanitize('Gemfile', '.', true).must_equal 'Gemfile'
+          end
+          it 'works with complex input' do
+            FilenameCleaner.sanitize('File$without!extension', '.', true).must_equal 'File.without.extension'
+          end
         end
-      end
-      context 'end of the filename' do
-        it 'strips the end of string if not letters or numbers' do
-          FilenameCleaner.sanitize_name_with_extension('filename .txt').must_equal 'filename.txt'
-          FilenameCleaner.sanitize_name_with_extension('filename  .txt').must_equal 'filename.txt'
-          FilenameCleaner.sanitize_name_with_extension('filename   !.txt').must_equal 'filename.txt'
+        context 'with non-default separator char' do
+          it 'works with simple input' do
+            FilenameCleaner.sanitize('Gemfile', '_', true).must_equal 'Gemfile'
+          end
+          it 'works with complex input' do
+            FilenameCleaner.sanitize('File$without!extension', '-', true).must_equal 'File-without-extension'
+          end
+        end
+        context 'special characters at boundary' do
+          it 'does not strip special characters that from extension' do
+            FilenameCleaner.sanitize('filename!!#@.txt!!', '.', true).must_equal 'filename.txt!!'
+          end
+          it 'strips the special characters that come before the extension' do
+            FilenameCleaner.sanitize('filename  !#@!.txt', '_', true).must_equal 'filename.txt'
+          end
         end
       end
-   end
+    end
   end
 end

data/test/test_helper.rb

@@ -1,3 +1,4 @@
+require 'minitest'
 require 'minitest/autorun'
 require 'minitest/pride'
 require 'minitest-spec-context'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filename_cleaner
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2014-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -204,6 +204,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".travis.yml"
 - ".yardopts"
 - CHANGELOGS.md
 - Gemfile