ebook_renamer 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68a848c366158d77e6fc15ba40102278560965d3
-  data.tar.gz: 9708d227f746c9daa2c26cfa702ad4edd76b0847
+  metadata.gz: 06938f447fa5bb2e2ca8c39497555ad4af092481
+  data.tar.gz: 43bb582e47b7a996b18b68389a8e035bb98681be
 SHA512:
-  metadata.gz: cd971e1f1c50c8d34ee42d39b6bef1b1678da72bdf251690909ced6392c41cb82ee69a92682e514799bfcb3ee5e1f7ed5ea673e71bee314f028ffb8aa84fd350
-  data.tar.gz: 8e212411f15a37cdf8f10fe5ed5a612457eafcc7c7c05e607fb969999f03e37be046f60705d89d93b62de7edff9cda2b7abf7d0a46dd2a8550eacc3cc574747a
+  metadata.gz: 01b405b2d3073da7ddf8595b793fe01ceb5b05621f9514d25a996678e9678fa9bccee357f9da23c4f50291bf959ec3fdbba9f2aec07159436233acce3e561813
+  data.tar.gz: c60b7a3ca43687844b4d9f006abf66d058e64de45db6280ed7b3114b4ea80a3b42db9b08a7b3bca8cbee61afebc00d101928d23c64bb09692e5c3dfb5c765da7

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ### Changelog
 
+#### 0.1.11
+
+- Make use of [filename_cleaner][] gem for renaming filename
+- Add new options
+  * `--downcase` to allow downcase of each word in the filename
+  * `--capitalize` to allow capitalization of each word in the filename
+- Fix the style with rubocop
+- Improve README.md
+
 #### 0.1.10
 
 - Code refactoring
@@ -82,5 +91,6 @@
 - Initial release
 
 [agile_utils]: https://rubygems.org/gems/agile_utils
+[filename_cleaner]: https://rubygems.org/gems/filename_cleaner
 [code_lister]: https://rubygems.org/gems/code_lister
 [Semantic Versioning]: http://semver.org

data/README.md

@@ -132,6 +132,18 @@ ebook_renamer --base-dir . --recursive --commit
 ebook_renamer -b . -r -c
 ```
 
+### Misc Options
+In addition to the above usage, you can also use the two new flags `--downcase` or
+`--capitalize`
+
+```shell
+# Lowercase each word in the result filename
+ebook_renamer --base-dir . --recursive --downcase --commit
+
+# Capitalize each word in the result filename
+ebook_renamer --base-dir . --recursive --capitalize --commit
+```
+
 ### Usage/Synopsis
 
 ```
@@ -139,16 +151,22 @@ Usage:
   ebook_renamer
 
 Options:
-  -b, [--base-dir=BASE_DIR]            # Base directory
-                                       # Default: . (current directory)
-  -r, [--recursive], [--no-recursive]  # Search for files recursively
-                                       # Default: true
-  -s, [--sep-string=SEP_STRING]        # Separator string between words in output filename
-                                       # Default: .
-  -c, [--commit], [--no-commit]        # Make change permanent
-  -v, [--version], [--no-version]      # Display version information
+  -b, [--base-dir=BASE_DIR]              # Base directory
+                                         # Default: . (current directory)
+  -r, [--recursive], [--no-recursive]    # Search for files recursively
+                                         # Default: --recursive
+  -s, [--sep-string=SEP_STRING]          # Separator string between words in output filename
+                                         # Default: . (dot string)
+  -d, [--downcase], [--no-downcase]      # Convert each word in the filename to lowercase
+                                         # Default: --no-downcase
+  -t, [--capitalize], [--no-capitalize]  # Capitalize each word in the filename
+                                         # Default: --no-capitalize
+  -c, [--commit], [--no-commit]          # Make change permanent
+                                         # Default: --no-commit
+  -v, [--version], [--no-version]        # Display version information
 
 Rename multiple ebook files (pdf,epub,mobi) from a given directory
+
 ```
 
 ### Contributing

data/ebook_renamer.gemspec

@@ -1,40 +1,41 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ebook_renamer/version'
+require "ebook_renamer/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'ebook_renamer'
+  spec.name          = "ebook_renamer"
   spec.version       = EbookRenamer::VERSION
-  spec.authors       = ['Burin Choomnuan']
-  spec.email         = ['agilecreativity@gmail.com']
+  spec.authors       = ["Burin Choomnuan"]
+  spec.email         = ["agilecreativity@gmail.com"]
   spec.description   = %q{Bulk rename of ebook files (pdf, epub, mobi) based on embedded metadata}
   spec.summary       = %q{Rename multiple ebook files (pdf, epub, mobi) based on existing metadata if available}
-  spec.homepage      = 'https://github.com/agilecreativity/ebook_renamer'
-  spec.license       = 'MIT'
-  spec.files         = Dir.glob('{bin,lib}/**/*') + %w(Gemfile
+  spec.homepage      = "https://github.com/agilecreativity/ebook_renamer"
+  spec.license       = "MIT"
+  spec.files         = Dir.glob("{bin,lib}/**/*") + %w[Gemfile
                                                        Rakefile
                                                        ebook_renamer.gemspec
                                                        README.md
                                                        CHANGELOG.md
                                                        LICENSE
                                                        .rubocop.yml
-                                                       .gitignore)
+                                                       .gitignore]
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
-  spec.add_runtime_dependency 'thor', '~> 0.19'
-  spec.add_runtime_dependency 'agile_utils', '~> 0.1'
-  spec.add_runtime_dependency 'code_lister', '~> 0.1'
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'awesome_print', '~> 1.2'
-  spec.add_development_dependency 'minitest-spec-context', '~> 0.0.3'
-  spec.add_development_dependency 'guard-minitest', '~> 2.2'
-  spec.add_development_dependency 'minitest', '~> 5.3'
-  spec.add_development_dependency 'guard', '~> 2.6'
-  spec.add_development_dependency 'pry', '~> 0.9'
-  spec.add_development_dependency 'gem-ctags', '~> 1.0'
-  spec.add_development_dependency 'yard', '~> 0.8'
-  spec.add_development_dependency 'rubocop', '~> 0.20'
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "thor", "~> 0.19"
+  spec.add_runtime_dependency "agile_utils", "~> 0.1"
+  spec.add_runtime_dependency "code_lister", "~> 0.1"
+  spec.add_runtime_dependency "filename_cleaner", "~> 0.3.8"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "awesome_print", "~> 1.2"
+  spec.add_development_dependency "minitest-spec-context", "~> 0.0.3"
+  spec.add_development_dependency "guard-minitest", "~> 2.2"
+  spec.add_development_dependency "minitest", "~> 5.3"
+  spec.add_development_dependency "guard", "~> 2.6"
+  spec.add_development_dependency "pry", "~> 0.9"
+  spec.add_development_dependency "gem-ctags", "~> 1.0"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "rubocop", "~> 0.20"
 end

data/lib/ebook_renamer.rb

@@ -3,5 +3,5 @@ require "code_lister"
 require "agile_utils"
 require_relative "ebook_renamer/version"
 require_relative "ebook_renamer/logger"
-require_relative "ebook_renamer/utils"
+require_relative "ebook_renamer/ebook_renamer"
 require_relative "ebook_renamer/cli"

data/lib/ebook_renamer/cli.rb

@@ -1,5 +1,6 @@
 require "agile_utils"
 require "code_lister"
+require "filename_cleaner"
 require "fileutils"
 require_relative "../ebook_renamer"
 module EbookRenamer
@@ -9,11 +10,21 @@ module EbookRenamer
     method_option *AgileUtils::Options::RECURSIVE
     method_option :sep_string,
                   aliases: "-s",
-                  desc: "Separator string between words in output filename",
+                  desc: "Separator string between each word in output filename",
                   default: "."
+    method_option :downcase,
+                  aliases: "-d",
+                  type: :boolean,
+                  desc: "Convert each word in the output filename to lowercase",
+                  default: false
+    method_option :capitalize,
+                  type: :boolean,
+                  aliases: "-t",
+                  desc: "Capitalize each word in the output filename",
+                  default: false
     method_option :commit,
                   aliases: "-c",
-                  desc: "Make change permanent",
+                  desc: "Make your changes permanent",
                   type: :boolean,
                   default: false
     method_option *AgileUtils::Options::VERSION
@@ -31,20 +42,27 @@ module EbookRenamer
     desc "usage", "Display help screen"
     def usage
       puts <<-EOS
+
 Usage:
   ebook_renamer
 
 Options:
-  -b, [--base-dir=BASE_DIR]            # Base directory
-                                       # Default: . (current directory)
-  -r, [--recursive], [--no-recursive]  # Search for files recursively
-                                       # Default: true
-  -s, [--sep-string=SEP_STRING]        # Separator string between words in output filename
-                                       # Default: .
-  -c, [--commit], [--no-commit]        # Make change permanent
-  -v, [--version], [--no-version]      # Display version information
+  -b, [--base-dir=BASE_DIR]              # Base directory
+                                         # Default: . (current directory)
+  -r, [--recursive], [--no-recursive]    # Search for files recursively
+                                         # Default: --recursive
+  -s, [--sep-string=SEP_STRING]          # Separator string between each word in output filename
+                                         # Default: '.' (dot string)
+  -d, [--downcase], [--no-downcase]      # Convert each word in the output filename to lowercase
+                                         # Default: --no-downcase
+  -t, [--capitalize], [--no-capitalize]  # Capitalize each word in the output filename
+                                         # Default: --no-capitalize
+  -c, [--commit], [--no-commit]          # Make your changes permanent
+                                         # Default: --no-commit
+  -v, [--version], [--no-version]        # Display version information
 
 Rename multiple ebook files (pdf,epub,mobi) from a given directory
+
       EOS
     end
 
@@ -53,13 +71,6 @@ Rename multiple ebook files (pdf,epub,mobi) from a given directory
   private
 
     # Rename the file from the given directory
-    #
-    # @param args [Hash<Symbol, Object>] options argument
-    # possible options
-    #  :base_dir  - the base directory
-    #  :recursive - perform the rename recursively (true|false)
-    #  :commit    - make the rename permanent (true|false)
-    #  :exts      - list of extensions to be processed default to ['epub,mobi,pdf']
     def execute(options = {})
       input_files = CodeLister.files(options)
       if input_files.empty?
@@ -88,16 +99,28 @@ Rename multiple ebook files (pdf,epub,mobi) from a given directory
 
     def compare_and_rename(input_file, meta_hash, options, index, total)
       if identical_name?(input_file, meta_hash)
-        puts "#{index + 1} of #{total} skip name: #{input_file} [no title found or file is identical]"
-        return
+        base_name = File.basename(input_file, ".*")
+        name = downcase_or_capitalize(base_name, options)
+        name = "#{File.dirname(input_file)}/#{name}#{File.extname(input_file)}"
+        output_file = File.expand_path(name)
+      else
+        output_file = compute_name(input_file, meta_hash, options)
       end
-      output_file = compute_name(input_file, meta_hash, options)
+      rename_if_not_the_same(input_file, output_file, index:  index,
+                                                      total:  total,
+                                                      commit: options[:commit])
+    end
+
+    def rename_if_not_the_same(input_file, output_file, options = {})
+      index  = options[:index]
+      total  = options[:total]
+      commit = options[:commit]
       if input_file != output_file
         puts "#{index + 1} of #{total} old name : #{input_file}"
         puts "#{index + 1} of #{total} new name : #{output_file}"
-        FileUtils.mv(input_file, output_file) if options[:commit]
+        FileUtils.mv(input_file, output_file) if commit
       else
-        puts "#{index + 1} of #{total} skip name: #{input_file} [file is identical]"
+        puts "#{index + 1} of #{total} skip name: #{input_file} [title is the same as the filename]"
       end
     end
 
@@ -109,13 +132,28 @@ Rename multiple ebook files (pdf,epub,mobi) from a given directory
 
     # Compute the new name from metadata
     #
-    # @todo make use of filename cleaner gem
     def compute_name(input_file, meta_hash, options)
       extension = File.extname(input_file)
       name = formatted_name(meta_hash, sep_char: " by ")
-      name = sanitize_filename(name, options[:sep_string])
+      name = FilenameCleaner.sanitize(name, options[:sep_string], false)
+      name = downcase_or_capitalize(name, options)
       name = "#{File.dirname(input_file)}/#{name}#{extension}"
       File.expand_path(name)
     end
+
+    # Post processing of the name
+    def downcase_or_capitalize(name, options)
+      downcase   = options[:downcase]
+      capitalize = options[:capitalize]
+      sep_string = options[:sep_string]
+      if capitalize
+        name = name.split(sep_string).map(&:capitalize).join(sep_string)
+      else
+        if downcase
+          name = name.split(sep_string).map(&:downcase).join(sep_string)
+        end
+      end
+      name
+    end
   end
 end

data/lib/ebook_renamer/{utils.rb → ebook_renamer.rb}

@@ -48,27 +48,6 @@ module EbookRenamer
     hash
   end
 
-  # Clean the filename to remove the special characters
-  #
-  # @param [String] filename input file
-  # @param [String] sep_char separator character to use
-  #
-  # @return [String] the new file name with special characters replaced or removed.
-  def sanitize_filename(filename, sep_char = nil)
-    dot = "."
-    # Note exclude the '.' (dot)
-    filename.gsub!(/[^0-9A-Za-z\-_ ]/, dot)
-    # replace multiple occurrences of a given char with a dot
-    ["-", "_", " "].each do |c|
-      filename.gsub!(/#{Regexp.quote(c)}+/, dot)
-    end
-
-    # replace multiple occurrence of dot with one dot
-    filename.gsub!(/#{Regexp.quote(dot)}+/, dot)
-    return filename.gsub!(/#{Regexp.quote(dot)}+/, sep_char) if sep_char
-    filename.strip
-  end
-
   # Return formatted file name using the metadata values
   #
   # @param [Hash<Symbol,String>] meta_hash output from the program 'ebook-meta' or 'exiftoo'
@@ -77,6 +56,8 @@ module EbookRenamer
     if hash.nil? || fields.nil?
       fail ArgumentError.new("Argument must not be nil")
     end
+    # Let's not continue if we have no title metadata
+    fail "No title found" unless meta_hash.fetch("title", nil)
 
     # The keys that we get from the 'mdls' or 'exiftool'
     args = {
@@ -92,48 +73,13 @@ module EbookRenamer
 
     # Note: only show if we have the value for title
     result = []
-    if meta_hash.fetch("title", nil)
-      keys.each do |k|
-        value = meta_hash.fetch(k, nil)
-        # Note: don't add 'Author(s)' => 'Unknown' to keep the result clean
-        if value && value.downcase != "unknown"
-          result << meta_hash[k]
-        end
+    keys.each do |key|
+      value = meta_hash.fetch(key, nil)
+      # Note: don't add 'Author(s)' => 'Unknown' to keep the result clean
+      if value && value.downcase != "unknown"
+        result << meta_hash[key]
       end
-      return result.join(sep_char)
-    end
-    # Note: if no title we choose to return empty value for result
-    ""
-  end
-
-  # Ensure that the values in hash are sanitized
-  #
-  # @param [Hash<Symbol,String>] hash input hash to be sanitized
-  # @return [Hash<Symbol,String>] original hash with values sanitized
-  # @see #sanitize_filename
-  def sanitize_values(hash = {})
-    hash.each do |key, value|
-      hash[key] = sanitize_filename(value, " ")
     end
-    hash
-  end
-
-  # List files base on given options
-  # options:
-  #  :recursive - process the directory recursively (default false)
-  #  :exts - list of extensions to be search (default ['epub','mobi','pdf'])
-  #
-  # @param base_dir [String] the starting directory
-  # @param options [Hash<Symbol,Object>] the options to be used
-  # @return [List<String>] list of matching files or empty list if none are found
-  def files(base_dir = Dir.pwd, options = {})
-    args = {
-      recursive: false,
-      exts: %w[epub mobi pdf]
-    }.merge(options)
-
-    wildcard = args[:recursive] ? "**" : ""
-    patterns = File.join(base_dir, wildcard, "*.{#{(args[:exts]).join(",")}}")
-    Dir.glob(patterns) || []
+    result.join(sep_char)
   end
 end

data/lib/ebook_renamer/version.rb

@@ -1,3 +1,3 @@
 module EbookRenamer
-  VERSION = "0.1.10"
+  VERSION = "0.1.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ebook_renamer
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-25 00:00:00.000000000 Z
+date: 2014-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: filename_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.8
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -225,8 +239,8 @@ files:
 - ebook_renamer.gemspec
 - lib/ebook_renamer.rb
 - lib/ebook_renamer/cli.rb
+- lib/ebook_renamer/ebook_renamer.rb
 - lib/ebook_renamer/logger.rb
-- lib/ebook_renamer/utils.rb
 - lib/ebook_renamer/version.rb
 homepage: https://github.com/agilecreativity/ebook_renamer
 licenses: