## 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]

[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
are first squeezed into one string and then replaced by any given string/char [default to . (a single dot)].

### Installation

```sh
gem install filename_cleaner
```

#### Use as command line interface (CLI)

Just type `filename_cleaner` without any options to see the list of help

```
Usage:
  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
  -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
                                           # Default: true
  -r, [--recursive], [--no-recursive]      # Search for files recursively
                                           # Default: true
  -v, [--version], [--no-version]          # Display version information
  -s, [--sep-char=SEP_CHAR]                # Separator char to use
                                           # Default: .
  -c, [--commit], [--no-commit]            # Commit your changes

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 rename --base-dir . --exts java rb --recursive --sep-char _
```

To make your change permanent:

```
cd ~/projects/files
filename_cleaner rename --base-dir . --exts java rb --recursive --sep-char _ --commit
```

#### Us as library in your project

Add this line to your application's Gemfile:

```
gem 'filename_cleaner'
```

And then execute:

```
$bundle
```

Example Usage:

- Use the default separator string '.'

```ruby
require 'filename_cleaner'
# work with the file that have extension
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
new_name = FilenameCleaner.sanitize_name('some b@d fil$name.txt', '_')
puts new_name # => 'some_b_d_fil_name_txt'
```

### Contributing

Bug reports and suggestions for improvements are always welcome,
GitHub pull requests are even better!.

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

[rubocop]: https://github.com/bbatsov/rubocop