filename_cleaner 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba0764b038df0404b93814f17a7309ada921ccf4
-  data.tar.gz: 1c6f72706886d64a1d895d221049c4da92b78cb6
+  metadata.gz: 8e4c0aad87875fbeee0976b1682cb3b2f30e0c3c
+  data.tar.gz: 8af35d698b9762048de68a92aa8af73d3e21a85e
 SHA512:
-  metadata.gz: 0ebc349f1f3a7bf4920086b78a588b65c48a9a1f8824454ebaad7f067ec343b25f4afd6411c8d9081a22d5ae6fcf2591d30fdc03bc0e410baaded9f9c3ae543a
-  data.tar.gz: 208964761eb2829daa8be48bcbe1d4d10dd17b5ed8bd7cac10363aac316b302d2f88ebc5709e44a9b520e570168bad863cd00cf05ae0c57ae481b1d97bd2067f
+  metadata.gz: 894666704a1dfe9bdfbe320ac027cc6873ef65fa5e81bb13380f2894df2084027895b623fdf69bc34b7fa1d30e4e80281714a2e2eac541e08ff29872cadaebdc
+  data.tar.gz: 4ff5423c8deb7ce03ed0ff9728d812155e3be8e80aef7d6b27454c6e0cd3294e4a7ec095c30fcdc532bc20fc3ac4d0e55c559b624c34a4d32e5453faac70c5f1

data/CHANGELOGS.md

@@ -1,5 +1,13 @@
 ### Changelogs
 
+#### 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 core_ext/object/blank.rb
+
 #### 0.1.1
 
 - Remove the last char from the filename if it is not numbers or letters

data/README.md

@@ -79,18 +79,13 @@ Example Usage:
 
 ```ruby
 require 'filename_cleaner'
-clean_name = FilenameCleaner::sanitize_filename('some b@d fil$name.txt')
-puts clean_name # => 'some.b.d.fil.name.txt'
-
-```
-
-- Specify the separator string
-
-```ruby
-require 'filename_cleaner'
-clean_name = FilenameCleaner::sanitize_filename('some b@d fil$name.txt', '_')
+# 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'
 
+# 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'
 ```
 
 ### Contributing

data/lib/filename_cleaner.rb

@@ -2,3 +2,4 @@ require 'uri'
 require_relative './filename_cleaner/version'
 require_relative './filename_cleaner/cli'
 require_relative './filename_cleaner/filename_cleaner'
+require_relative './filename_cleaner/core_ext/object/blank'

data/lib/filename_cleaner/cli.rb

@@ -72,7 +72,7 @@ Options:
           puts "FYI: process : #{index + 1} of #{files.size}"
           dirname  = File.dirname(File.expand_path(file))
           filename = File.basename(file)
-          sanitized_name = FilenameCleaner::sanitize_filename(filename, options[:sep_char])
+          sanitized_name = FilenameCleaner::sanitize_name_with_extension(filename, options[:sep_char])
           old_name = File.expand_path(file)
           new_name = File.expand_path([dirname, sanitized_name].join(File::SEPARATOR))
 

data/lib/filename_cleaner/core_ext/object/blank.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+# from: active_support/core_ext/object/blank.rb
+class Object
+  # An object is blank if it's false, empty, or a whitespace string.
+  # For example, '', '   ', +nil+, [], and {} are all blank.
+  #
+  # This simplifies:
+  #
+  #   if address.nil? || address.empty?
+  #
+  # ...to:
+  #
+  #   if address.blank?
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+
+  # An object is present if it's not <tt>blank?</tt>.
+  def present?
+    !blank?
+  end
+
+  # Returns object if it's <tt>present?</tt> otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to <tt>object.present? ? object : nil</tt>.
+  #
+  # This is handy for any representation of objects where blank is the same
+  # as not present at all. For example, this simplifies a common check for
+  # HTTP POST/query parameters:
+  #
+  #   state   = params[:state]   if params[:state].present?
+  #   country = params[:country] if params[:country].present?
+  #   region  = state || country || 'US'
+  #
+  # ...becomes:
+  #
+  #   region = params[:state].presence || params[:country].presence || 'US'
+  def presence
+    self if present?
+  end
+end
+
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  def blank?
+    true
+  end
+end
+
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  def blank?
+    true
+  end
+end
+
+class TrueClass
+  # +true+ is not blank:
+  #
+  #   true.blank? # => false
+  def blank?
+    false
+  end
+end
+
+class Array
+  # An array is blank if it's empty:
+  #
+  #   [].blank?      # => true
+  #   [1,2,3].blank? # => false
+  alias_method :blank?, :empty?
+end
+
+class Hash
+  # A hash is blank if it's empty:
+  #
+  #   {}.blank?                # => true
+  #   { key: 'value' }.blank?  # => false
+  alias_method :blank?, :empty?
+end
+
+class String
+  # A string is blank if it's empty or contains whitespaces only:
+  #
+  #   ''.blank?                 # => true
+  #   '   '.blank?              # => true
+  #   '　'.blank?               # => true
+  #   ' something here '.blank? # => false
+  def blank?
+    self !~ /[^[:space:]]/
+  end
+end
+
+class Numeric #:nodoc:
+  # No number is blank:
+  #
+  #   1.blank? # => false
+  #   0.blank? # => false
+  def blank?
+    false
+  end
+end

data/lib/filename_cleaner/filename_cleaner.rb

@@ -1,47 +1,48 @@
 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
     #
     # @param [String] filename the input filename with extension
-    # @retyrn [String] the output file with special characters replaced.
-    def sanitize_filename(filename, sep_char = '.')
+    # @return [String] the output file with special characters replaced.
+    def sanitize_name_with_extension(filename, sep_char = '.')
       extension = File.extname(filename)
-      if extension.empty?
-        replace_dot!(sanitize(filename), sep_char)
-      else
-        name_only = File.basename(filename, ".*")
-        name_only = replace_dot!(sanitize(name_only), sep_char)
-        "#{name_only}#{extension}"
-      end
+      name_only = File.basename(filename, ".*")
+      name_only = replace_dot!(sanitize_with_dot(name_only), sep_char)
+      "#{name_only}#{extension}"
     end
 
-    # Clean the the input string to remove the special characters
+    private
+
+    # Replace the multipe special characters with a dot
     #
-    # @param [String] filename input file
-    # @return [String] the new file name with special characters replaced or removed.
-    def sanitize(filename)
-      # remove anything that is not letters, numbers, dash, underscore or space
-      # Note: we intentionally ignore dot from the list
-      filename.gsub!(/[^0-9A-Za-z\-_ ]/, DOT)
-
-      # replace multiple occurrences of a given char with a dot
+    # @param [String] name input file
+    # @return [String] the new name with special characters replaced or removed.
+    def sanitize_with_dot(name)
+      # Replace any special characters with a dot
+      name.gsub!(/[^0-9A-Za-z\-_ ]/, DOT)
+
+      # Replace multiple occurrences of a given character with a dot
       ['-', '_', ' '].each do |c|
-        filename.gsub!(/#{Regexp.quote(c)}+/, DOT)
+        name.gsub!(/#{Regexp.quote(c)}+/, DOT)
       end
 
-      # replace multiple occurrence of dot with one dot
-      filename.gsub!(/#{Regexp.quote(DOT)}+/, DOT)
+      # Replace multiple occurrence of dot with one dot
+      name.gsub!(/#{Regexp.quote(DOT)}+/, DOT)
 
-      # remove the last char if it is a dot
-      filename.gsub!(/\.$/, '') if filename[-1] == DOT
+      # Remove the last char if it is a dot
+      name.gsub!(/\.$/, '') if name[-1] == DOT
 
-      filename
+      # return the result
+      name
     end
 
-    private
-
-    # replace 'dot' string with a agiven string if any
+    # replace 'dot' string with a given string if specified
     def replace_dot!(string, replace = nil)
       string.gsub!(/#{Regexp.quote(DOT)}+/, replace) if replace
       string

data/lib/filename_cleaner/version.rb

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

data/test/lib/filename_cleaner/test_filename_cleaner.rb

@@ -1,58 +1,58 @@
 require_relative '../../test_helper'
 describe FilenameCleaner do
-  context '#sanitize' do
-    it 'works with simple input' do
-      FilenameCleaner.sanitize('any txt').must_equal 'any.txt'
-      FilenameCleaner.sanitize('this is a long filename.txt').must_equal 'this.is.a.long.filename.txt'
-    end
-    it 'works with text with extension' do
-      FilenameCleaner.sanitize('filename.txt').must_equal 'filename.txt'
-    end
-    it 'strips the end of string if not letters or numbers' do
-      FilenameCleaner.sanitize('filename .txt').must_equal 'filename.txt'
-      FilenameCleaner.sanitize('filename  .txt').must_equal 'filename.txt'
-      FilenameCleaner.sanitize('filename   !.txt').must_equal 'filename.txt'
-    end
-  end
-  context '#sanitize_filename' 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_filename('some!!!$file$:%.txt').must_equal 'some.file.txt'
+        FilenameCleaner.sanitize_name_with_extension('some!!!$file$:%.txt').must_equal 'some.file.txt'
       end
       it 'works with default separator' do
-        FilenameCleaner.sanitize_filename('some file.txt').must_equal 'some.file.txt'
+        FilenameCleaner.sanitize_name_with_extension('some file.txt').must_equal 'some.file.txt'
       end
       it 'works with non-default separator' do
-        FilenameCleaner.sanitize_filename('some file.txt', '_').must_equal 'some_file.txt'
+        FilenameCleaner.sanitize_name_with_extension('some file.txt', '_').must_equal 'some_file.txt'
       end
     end
     describe 'file without extension' do
       it 'replaces mutilple consecutive chars with one' do
-        FilenameCleaner.sanitize_filename('some!!!$file$:%.').must_equal 'some.file'
+        FilenameCleaner.sanitize_name_with_extension('some!!!$file$:%.').must_equal 'some.file'
       end
       context 'using default separator' do
         it 'works with simple input' do
-          FilenameCleaner.sanitize_filename('Gemfile').must_equal 'Gemfile'
+          FilenameCleaner.sanitize_name_with_extension('Gemfile').must_equal 'Gemfile'
         end
         it 'works with complex input' do
-          FilenameCleaner.sanitize_filename('File$without!extension').must_equal 'File.without.extension'
+          FilenameCleaner.sanitize_name_with_extension('File$without!extension').must_equal 'File.without.extension'
         end
       end
       context 'with non-default separator char' do
         it 'works with simple input' do
-          FilenameCleaner.sanitize_filename('Gemfile', '_').must_equal 'Gemfile'
+          FilenameCleaner.sanitize_name_with_extension('Gemfile', '_').must_equal 'Gemfile'
         end
         it 'works with complex input' do
-          FilenameCleaner.sanitize_filename('File$without!extension', '-').must_equal 'File-without-extension'
+          FilenameCleaner.sanitize_name_with_extension('File$without!extension', '-').must_equal 'File-without-extension'
         end
       end
       context 'end of the filename' do
         it 'strips the end of string if not letters or numbers' do
-          FilenameCleaner.sanitize_filename('filename .txt').must_equal 'filename.txt'
-          FilenameCleaner.sanitize_filename('filename  .txt').must_equal 'filename.txt'
-          FilenameCleaner.sanitize_filename('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'
+          FilenameCleaner.sanitize_name_with_extension('filename   !.txt').must_equal 'filename.txt'
         end
       end
-    end
+   end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: filename_cleaner
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Burin Choomnuan
@@ -215,6 +215,7 @@ files:
 - filename_cleaner.gemspec
 - lib/filename_cleaner.rb
 - lib/filename_cleaner/cli.rb
+- lib/filename_cleaner/core_ext/object/blank.rb
 - lib/filename_cleaner/filename_cleaner.rb
 - lib/filename_cleaner/version.rb
 - rubocop-todo.yml