ebook_renamer 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0e4104daed6e556eb3241169fba5746f4feabcc
-  data.tar.gz: 9fa908281368c84281e7d71e66ba7e7bf8586f73
+  metadata.gz: 5a2139b4a762320fd57c0f4fa7bc7a596fa9fe7e
+  data.tar.gz: 9e398f2a27d81053475b3fae18fe92b7de07d8d3
 SHA512:
-  metadata.gz: a2733518e944cb0a833715fe645556a807b7f36a26340eb1a6f8df0be6d053e0412a81becd752c8dbdba8eb4c0049f06bbc6272545726f0bbb21ccbcfb5faff2
-  data.tar.gz: 7c5694af153aead28f0a82857a4fda073d2b6a4f87a8a18b2328aff47830a0175f81199c826399a80949e6b7641c2a187d53d8623c940979c0b8b59f84e3c11b
+  metadata.gz: 48751c782e8240b4a539a04bbaed42235c0e620c016fa3c3f298874c7de6f7c4d4eae4cfd08afa56a0d45a6769a2dae7f127c369536d39ace8db3b3c3157c4da
+  data.tar.gz: c88f3706a48f84c46c4cb102e89502d6fe943d05fabe6e39baa1b16b1da909f665ec3193350b3195b6fb4cd16bb73284d15ac120cec61aae79fdfc477b7e3553

data/README.md

@@ -5,15 +5,12 @@ the metadata within the ebook itself (if available).
 
 ### Why do I wrote this gem
 
-Almost always when I purchase an ebook (or download a file from the internet) it always came with the
-bad name. I really like the meaningful name to the file that I have and really hate to rename them manually.
+Almost always, when I get an ebook it does not have a good file name.
+This is very annoying as it does not work well when you want to search for it later.
 
-I wrote this gem just to make it easy to rename the files in bulk and recursively.
-
-This gem will rename any ebook files (pdf, epub, mobi) using the available
-meta-data that embedded within them.
-
-So if you don't like to spend time renaming them manually then this gem is for you.
+I wrote this gem just to make it possible to rename multiple ebook files at once using the
+available meta-data from each file. I like to be able to use this on the single folder or recursively from
+a given folder.
 
 ### How the file is renamed
 
@@ -22,10 +19,12 @@ The file will be renamed using the following format `<title>.by.<author(s)>`.`<e
 Also the final file name will be sanitized e.g. any multiple occurence of special characters will be
 replace by one dot `.`.
 
-For example if the meta-data of the ebook contain the title `Start with Why: How Grate Leader Inspire Everyone to Take Action`
-and the author is `Simon Sinek` then the output will be `Start.with.Why.How.Great.Leader.Inspire.Everyone.to.Take.Action.by.Simon.Sinek.pdf`
+For example if the ebook contain the title `Start with Why: How Grate Leader Inspire Everyone to Take Action`
+and the author is `Simon Sinek` then the default output will be `Start.with.Why.How.Great.Leader.Inspire.Everyone.to.Take.Action.by.Simon.Sinek.pdf`
 Note that the `:` and one space before the word `How` is replaced with just one dot string.
 
+if the `--sep-string` is used then the output will be `Start_with_Why_How_Great_Leader_Inspire_Everyone_to_Take_Action_by_Simon_Sinek.pdf` for `--sep-string _` argument.
+
 ### What you will need
 
 * You will need to install the [Calibre](http://www.calibre-ebook.com/) and
@@ -33,12 +32,6 @@ Note that the `:` and one space before the word `How` is replaced with just one
 
 * Linux or Mac OSX operating system
 
-### Problems/Issues
-
-- Error may be raised if the combined meta-data is too long.
-e.g. if your files is stored in NTFS drive then you may get the error indicate the file is too long
-or something similar. I will try to handle this error in the next few release.
-
 ### Installation and Usage:
 
 ```sh
@@ -52,20 +45,20 @@ Run the following command from the directory that contain the file(s) that
 you want to rename.
 
 ```sh
-# cd to the directory containing the file you like to rename
-cd ~/Dropbox/ebooks/
+# Cd to the directory containing the file(s) you like to rename
+$cd ~/Dropbox/ebooks/
 
-# or specify the directory as an option
-ebook_renamer --base-dir ~/Dropbox/ebooks/samples
+# Or specify the directory as an option from any where you have access to the gem
+$ebook_renamer rename --base-dir ~/Dropbox/ebooks/samples
 
-# If you like to see the usage try
-ebook_renamer --help
+# For help on how to use the gem just type without any options.
+ebook_renamer
 
-# Run the command without making any changes to the files (dry-run)
-ebook_rename  --recursive
+# Run the command without making any changes to the files (dry-run) in the current directory
+$ebook_renamer  --base-dir . --recursive
 
-# Once you are happy with what you see, then
-ebook_renamer --recusive --commit
+# Once you are happy with what result then
+$ebook_renamer --base-dir . --recursive --commit
 ```
 
 ### Example Outputs
@@ -78,115 +71,80 @@ test/fixtures/
     ├── demo1.pdf
     ├── demo2.epub
     └── subdir
-        ├── demo3.pdf
-        └── demo4.epub
+        ├── demo1.pdf
+        └── demo2.epub
 2 directories, 4 files
 ```
 
 Run the command without making any changes
 
 ```sh
-./bin/ebook_renamer --base-dir ./test/fixtures/ebooks --recursive
+./bin/ebook_renamer rename --base-dir ./test/fixtures/ebooks --recursive
 ```
 
 You should see the result like the following
 
 ```
-Your options: {:base_dir=>"test/fixtures/ebooks/", :meta_binary=>"ebook-meta", :recursive=>true, :commit=>false}
-Input :test/fixtures/ebooks/demo1.pdf
-Output:test/fixtures/ebooks/Fearless.Refactoring.by.Andrzej.Krzywda.pdf
-Input :test/fixtures/ebooks/demo2.epub
-Output:test/fixtures/ebooks/EPUB.3.0.Specification.by.EPUB.3.Working.Group.epub
-Input :test/fixtures/ebooks/subdir/demo3.pdf
-Output:test/fixtures/ebooks/subdir/Reliably.Deploying.Rails.Applications.by.Ben.Dixon.pdf
-Input :test/fixtures/ebooks/subdir/demo4.epub
-Output:test/fixtures/ebooks/subdir/EPUB.3.0.Specification.by.EPUB.3.Working.Group.epub
+Your argument: {:base_dir=>".", :exts=>["pdf", "epub", "mobi"], :sep_string=>".", :commit=>false, :recursive=>true, :version=>false}
+Changes will not be applied without the --commit option.
+[./test/fixtures/ebooks/demo1.pdf] -> [./test/fixtures/ebooks/Fearless.Refactoring.by.Andrzej.Krzywda.pdf]
+[./test/fixtures/ebooks/demo2.epub] -> [./test/fixtures/ebooks/EPUB.3.0.Specification.by.EPUB.3.Working.Group.epub]
+[./test/fixtures/ebooks/subdir/demo1.pdf] -> [./test/fixtures/ebooks/subdir/Reliably.Deploying.Rails.Applications.by.Ben.Dixon.pdf]
+[./test/fixtures/ebooks/subdir/demo2.epub] -> [./test/fixtures/ebooks/subdir/EPUB.3.0.Specification.by.EPUB.3.Working.Group.epub]
 ```
 
-To actually rename the files using the following command
+To actually make the actual rename just pass in the `--commit` option like
 
 ```sh
-./bin/ebook_renamer --base-dir ./test/fixtures/ebooks --recursive --commit
-# or short version
-./bin/ebook_renamer -b ./test/fixtures/ebooks -r -c
+./bin/ebook_renamer rename --base-dir ./test/fixtures/ebooks --recursive --commit
+./bin/ebook_renamer rename -b ./test/fixtures/ebooks -r -c
 ```
 
-Note:
-
-The file will be renamed using the following format `<title>.by.<author(s)>`.`<extension>`
-Also the final file name will be sanitized e.g. any special characters will be
-converted to one dot `.`.
-
-For example if the title is `Start with Why: How Grate Leader Inspire Everyone to Take Action` and the author is `Simon Sinek` then
-the output will be something like `Start.with.Why.How.Great.Leader.Inspire.Everyone.to.Take.Action.by.Simon.Sinek.pdf` etc.
-
-### Sample Usage (from `ebook_renamer --help`)
+The final output should be like
 
 ```
- Usage: ebook_renamer [options]
-
- Examples:
-
-  1) $ebook_renamer
-
-  2) $ebook_renamer --base-dir ~/Dropbox/ebooks
-
-  3) $ebook_renamer --base-dir ~/Dropbox/ebooks
-                    --recursive
-
-  4) $ebook_renamer --base-dir ~/Dropbox/ebooks
-                    --recursive
-
-  5) $ebook_renamer --base-dir ~/Dropbox/ebooks
-                    --recursive
-                    --commit
-
-  6) $ebook_renamer --base-dir ~/Dropbox/ebooks
-                    --recursive
-                    --commit
+test/fixtures/
+└── ebooks
+    ├── Fearless.Refactoring.by.Andrzej.Krzywda.pdf
+    ├── EPUB.3.0.Specification.by.EPUB.3.Working.Group.epub
+    └── subdir
+        ├── Fearless.Refactoring.by.Andrzej.Krzywda.pdf
+        └── EPUB.3.0.Specification.by.EPUB.3.Working.Group.epub
+2 directories, 4 files
+```
 
-  7) $ebook_renamer --base-dir ~/Dropbox/ebooks
-                    --recursive
-                    --sep-string '_'
-                    --commit
- Options:
+### Sample Usage
 
-    -b, --base-dir directory         Starting directory [default - current directory]
-    -s, --sep-string string          Separator string [default - '.']
-    -r, --recursive                  Process the files recursively [default - false]
-    -c, --commit                     Perform the actual rename [default - false]
-    -v, --version                    Display version number
-    -h, --help                       Display this screen
+```
+Usage:
+  ebook_renamer rename
+
+Options:
+  -b, [--base-dir=BASE_DIR]            # Base directory
+                                       # Default: /home/bchoomnuan/Dropbox/spikes/ebooks-renamer
+  -e, [--exts=one two three]           # List of extensions to search for
+                                       # Default: ["pdf", "epub", "mobi"]
+  -s, [--sep-string=SEP_STRING]        # Separator string between words in filename
+                                       # Default: .
+  -c, [--commit], [--no-commit]        # Make change permanent
+  -r, [--recursive], [--no-recursive]  # Search for files recursively
+  -v, [--version], [--no-version]      # Display version information
+
+Rename ebook files (pdf,epub,mobi)
 ```
 
 ### Changelog
 
-#### 0.0.7
-
-- More improvement and code cleanup
-
-#### 0.0.6
+#### 0.0.8
 
-- Fix and update README.md
+- Use Thor instead of OptionParser for parsing of options
 
-#### 0.0.5
+#### 0.0.2 - 0.0.7
 
-- Update the README.md to include usage example
-
-#### 0.0.4
-
-- fix the stupid bug with the `which` method which raise invalid error
-- update README.md to reflect the change
-
-#### 0.0.3
-
-- make it possible to change the path to the binary
-
-#### 0.0.2
-
-- fix the silly refactoring bug
+- Improvement of code and fix the few bugs a long the way
 
 #### 0.0.1
+
 - Initial release
 
 ### Contributing

data/Rakefile

@@ -9,7 +9,6 @@ end
 
 task :default => :test
 
-## see: http://erniemiller.org/2014/02/05/7-lines-every-gems-rakefile-should-have/
 task :irb do
   require 'irb'
   require 'awesome_print'
@@ -20,7 +19,6 @@ task :irb do
   IRB.start
 end
 
-## see: http://lucapette.com/pry/pry-everywhere/
 task :pry do
   require 'pry'
   require 'awesome_print'

data/bin/ebook_renamer

@@ -1,32 +1,8 @@
 #!/usr/bin/env ruby
-begin
-  require 'ebook_renamer'
-rescue LoadError
-  $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-  require 'ebook_renamer'
-end
-
+require 'thor'
+require 'pry'
+require_relative '../lib/ebook_renamer'
+require_relative '../lib/ebook_renamer/helper'
+require_relative '../lib/ebook_renamer/version'
 include EbookRenamer
-include EbookRenamer::Options
-require 'ostruct'
-
-begin
-  options = parse_options()
-  EbookRenamer.logger.debug "Your options: #{options}"
-
-  #meta_binary = options.delete(:meta_binary)
-  sep_string  = options.delete(:sep_string)
-
-  EbookRenamer.configure do |config|
-    #config.meta_binary = meta_binary if meta_binary
-    config.sep_string  = sep_string  if sep_string
-  end
-
-  cli = EbookRenamer::CLI.new(EbookRenamer.configuration)
-  cli.rename(options[:base_dir], options)
-  exit 0
-rescue ArgumentError => e
-  puts e
-  exit 1
-end
-# vim: ft=ruby
+EbookRenamer::Command.start(ARGV)

data/ebook_renamer.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "thor"
 
   spec.add_development_dependency "minitest-spec-context", "~> 0.0.3"
   spec.add_development_dependency "guard-minitest", "~> 2.2"

data/lib/ebook_renamer.rb

@@ -1,6 +1,128 @@
-require 'ebook_renamer/version'
-require 'ebook_renamer/logger'
-require 'ebook_renamer/helpers'
-require 'ebook_renamer/configuration'
-require 'ebook_renamer/options'
-require 'ebook_renamer/cli'
+require 'thor'
+require 'ap'
+module EbookRenamer
+  class Command < Thor
+    desc "rename", "Rename ebook files (pdf,epub,mobi)"
+
+    method_option :base_dir,
+                  aliases: "-b",
+                  desc: "Base directory",
+                  default: Dir.pwd
+
+    method_option :exts,
+                  aliases: "-e",
+                  desc: "List of extensions to search for",
+                  type: :array,
+                  default: %w(pdf epub mobi)
+
+    method_option :sep_string,
+                  aliases: "-s",
+                  desc: "Separator string between words in filename",
+                  default: "."
+
+    method_option :commit,
+                  aliases: "-c",
+                  desc: "Make change permanent",
+                  type: :boolean,
+                  default: false
+
+    method_option :recursive,
+                  aliases: "-r",
+                  desc: "Search for files recursively",
+                  type: :boolean,
+                  default: false
+
+    method_option :version,
+                  aliases: "-v",
+                  desc: "Display version information",
+                  type: :boolean,
+                  default: false
+
+    def rename
+      args = options.symbolize_keys
+      puts "Your argument: #{args}"
+
+      if options[:version]
+        puts EbookRenamer::VERSION
+        exit
+      end
+
+      execute(args)
+    end
+
+    desc "help", "Display help screen"
+    def help
+      puts <<-EOS
+Usage:
+  ebook_renamer rename
+
+Options:
+  -b, [--base-dir=BASE_DIR]            # Base directory
+                                       # Default: /home/bchoomnuan/Dropbox/spikes/ebooks-renamer
+  -e, [--exts=one two three]           # List of extensions to search for
+                                       # Default: ["pdf", "epub", "mobi"]
+  -s, [--sep-string=SEP_STRING]        # Separator string between words in filename
+                                       # Default: .
+  -c, [--commit], [--no-commit]        # Make change permanent
+  -r, [--recursive], [--no-recursive]  # Search for files recursively
+  -v, [--version], [--no-version]      # Display version information
+
+Rename ebook files (pdf,epub,mobi)
+      EOS
+    end
+
+    default_task :help
+
+    private
+
+    # Rename the file from the given directory
+    # Using the with the argurment options as follow
+    #
+    #   :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']
+    #
+    # @param args [Hash<Symbol, Object>] options argument
+    def execute(args = {})
+      meta_binary = "ebook-meta"
+      options = default_options.merge(args)
+
+      input_files = files(options[:base_dir], options).sort
+
+      if input_files.empty?
+        puts "No file found for your option:", options
+        ap options
+        return
+      end
+
+      unless options[:commit]
+        puts "Changes will not be applied without the --commit option."
+      end
+
+      input_files.each do |file|
+        extension = File.extname(file)
+        begin
+          hash = meta_to_hash(meta(file, meta_binary))
+          full_name = formatted_name(hash, sep_char: " by ")
+          new_name  = "#{File.dirname(file)}/#{sanitize_filename(full_name, options[:sep_string])}#{extension}"
+          puts "[#{file}] -> [#{new_name}]"
+          FileUtils.mv(file,new_name) if options[:commit] && file != new_name
+        rescue RuntimeError => e
+          puts e.backtrace
+          next
+        end
+      end
+    end
+
+    def default_options
+      options = {
+        base_dir: Dir.pwd,
+        recursive: false,
+        commit: false,
+        exts: %w(epub mobi pdf),
+        sep_string: '.'
+      }
+    end
+  end
+end

data/lib/ebook_renamer/core_ext/hash.rb

@@ -0,0 +1,36 @@
+class Hash
+
+  # File activesupport/lib/active_support/core_ext/hash/keys.rb
+  #
+  # hash = { name: 'Rob', age: '28' }
+  # hash.transform_keys{ |key| key.to_s.upcase }
+  # => { "NAME" => "Rob", "AGE" => "28" }
+  def transform_keys
+    result = {}
+    each_key do |key|
+      result[yield(key)] = self[key]
+    end
+    result
+  end
+
+  def transform_keys!(&block)
+    keys.each do |key|
+      value = delete(key)
+      self[yield(key)] = value.is_a?(Hash) ? value.transform_keys!(&block) : value
+    end
+    self
+  end
+
+  # hash = { 'name' => 'Rob', 'age' => '28' }
+  # hash.symbolize_keys
+  # => { name: "Rob", age: "28" }
+  def symbolize_keys
+    transform_keys{ |key| key.to_sym rescue key }
+  end
+
+  # File activesupport/lib/active_support/core_ext/hash/keys.rb, line 135
+  def symbolize_keys!
+    transform_keys!{ |key| key.to_sym rescue key }
+  end
+
+end

data/lib/ebook_renamer/helper.rb

@@ -0,0 +1,168 @@
+require 'open3'
+require 'fileutils'
+require 'shellwords'
+require_relative "./core_ext/hash"
+module EbookRenamer
+
+  EbookMetaNotInstall = Class.new(StandardError)
+
+  # Extract meta data from the input file using the ebook-meta tool
+  #
+  # @param [String] filename the input file name
+  # @param [String] binary the executable for use to extract the metadata
+  # @return [String] result of the output from running the command
+  def meta(filename, binary = 'ebook-meta')
+    raise EbookMetaNotInstall, "Need to install ebook-meta to use this gem" if which(binary).nil?
+    command = [
+      binary,
+      Shellwords.escape(filename)
+    ]
+
+    stdout_str, stderr_str, status = Open3.capture3(command.join(" "))
+    raise "Problem processing #{filename}" unless status.success?
+    stdout_str
+  end
+
+  # Convert the output string to hash
+  #
+  # @param [String] text output string from the 'ebook-meta' command
+  # @return [Hash<String,String>] hash pair for the input string
+  def meta_to_hash(text)
+    hash = {}
+    return hash if text.nil?
+    result_list = []
+
+    text.split(/\n/).each do |meta|
+      # split by the first ':' string
+      list = meta.split /^(.*?):/
+
+      # ignore the empty string element
+      list.delete_at(0)
+
+      unless list.empty?
+        list.map(&:strip!)
+        # downcase the first item to make it easy
+        result_list << [list[0].downcase, list[1]]
+        hash = Hash[*result_list.flatten]
+      end
+    end
+    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)
+
+    if sep_char
+      # File.basename("demo.txt", ".*") #=> "demo"
+      name_only = File.basename(filename, ".*")
+      # File.extname("demo.txt")        #=> ".txt"
+      ext_only = File.extname(filename)
+      name_only.gsub!(/#{Regexp.quote(dot)}+/, sep_char)
+      return "#{name_only}#{ext_only}"
+    end
+
+    filename.strip
+  end
+
+  # Cross-platform way of finding an executable in the $PATH.
+  #
+  # @param command [String] the command to look up
+  # @return [String, NilClass] full path to the executable file or nil if the
+  #  executable is not valid or available.
+  # Example:
+  #   which('ruby')           #=> /usr/bin/ruby
+  #   which('bad-executable') #=> nil
+  def which(command)
+    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+      exts.each { |ext|
+        exe = File.join(path, "#{command}#{ext}")
+        return exe if File.executable? exe
+      }
+    end
+    return nil
+  end
+
+  # Return formatted file name using the metadata values
+  #
+  # @param [Hash<Symbol,String>] meta_hash output from the program 'ebook-meta' or 'exiftoo'
+  # @param [Hash<Symbol,String>] fields list of fields that will be used to set the name
+  def formatted_name(meta_hash = {}, fields = {})
+    if hash.nil? || fields.nil?
+      raise ArgumentError.new("Argument must not be nil")
+    end
+
+    # The keys that we get from the 'mdls' or 'exiftool'
+    args = {
+      keys: ['title',
+              'author(s)'],
+      sep_char: ' '
+    }.merge(fields)
+
+    keys = args[:keys]
+    sep_char = args[:sep_char]
+
+    # 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
+      end
+      return result.join(sep_char)
+    end
+    # Note: if no title we choose to return empty value for result
+    return ""
+  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) || []
+  end
+end

data/lib/ebook_renamer/version.rb

@@ -1,3 +1,3 @@
 module EbookRenamer
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/test/lib/ebook_renamer/helpers_test.rb

@@ -1,15 +1,15 @@
 require_relative '../../test_helper'
 describe EbookRenamer do
 
-  subject { EbookRenamer::Helpers }
+  include EbookRenamer
 
   before do
-    @sample = EbookRenamer::Helpers.meta("./test/fixtures/ebooks/demo1.pdf")
+    @sample = meta("./test/fixtures/ebooks/demo1.pdf")
   end
 
   context "#meta" do
     it "raises error on invalid input" do
-      ->{ subject.meta("invalid-filename") }.must_raise RuntimeError
+      ->{ meta("invalid-filename") }.must_raise RuntimeError
     end
 
     it "returns valid valid input" do
@@ -20,16 +20,16 @@ describe EbookRenamer do
 
   context "#meta_to_hash" do
     it 'returns empty hash' do
-      subject.meta_to_hash(nil).must_be_empty
+      meta_to_hash(nil).must_be_empty
     end
     it 'returns non-empty hash' do
-      hash = EbookRenamer::Helpers.meta_to_hash(@sample)
+      hash = meta_to_hash(@sample)
       hash.wont_be_empty
     end
 
     describe 'invalid format' do
       it 'return empty hash' do
-        subject.meta_to_hash('aa bb').must_equal({})
+        meta_to_hash('aa bb').must_equal({})
       end
     end
 
@@ -44,7 +44,7 @@ describe EbookRenamer do
         END
       }
 
-      let(:result) { subject.meta_to_hash(sample) }
+      let(:result) { meta_to_hash(sample) }
 
       it "returns proper type for result" do
         result.must_be_instance_of Hash
@@ -62,31 +62,31 @@ describe EbookRenamer do
 
   context "#sanitize_filename" do
     it "must be defined" do
-      subject.must_respond_to :sanitize_filename
+      must_respond_to :sanitize_filename
     end
 
     it "replaces multiple valid chars with one" do
-      subject.sanitize_filename('Valid-    -fil3_name......___   .txt').must_equal('Valid.fil3.name.txt')
+      sanitize_filename('Valid-    -fil3_name......___   .txt').must_equal('Valid.fil3.name.txt')
     end
 
     it "replaces multiple valid chars with one" do
-      subject.sanitize_filename('valid filename_.txt').must_equal('valid.filename.txt')
+      sanitize_filename('valid filename_.txt').must_equal('valid.filename.txt')
     end
 
     it "uses sepc_char correctly" do
-      subject.sanitize_filename('valid.file name.txt','_').must_equal('valid_file_name.txt')
+      sanitize_filename('valid.file name.txt','_').must_equal('valid_file_name.txt')
     end
   end
 
   context '#which' do
     describe 'valid executable' do
       it 'works with valid executable' do
-        subject.which('ruby').wont_be_nil
+        which('ruby').wont_be_nil
       end
     end
     describe 'invalid executable' do
       it 'works with invalid executable' do
-        subject.which('@not-a-valid-executable!').must_be_nil
+        which('@not-a-valid-executable!').must_be_nil
       end
     end
   end
@@ -94,29 +94,29 @@ describe EbookRenamer do
   context '#formatted_name' do
     describe 'invalid parameters' do
       it 'raises exception on nil arguments' do
-        -> { subject.formatted_name({}, nil)}.must_raise ArgumentError
+        -> { formatted_name({}, nil)}.must_raise ArgumentError
       end
       it 'returns nil on empty hash' do
-        subject.formatted_name({}, {}).must_be_empty
+        formatted_name({}, {}).must_be_empty
       end
     end
 
     describe 'valid parameters' do
       it 'returns result based on single key' do
-        subject.formatted_name({'title'      => 'The Firm',
-                                'author'     => 'John Grisham',
-                                'page count' => 399 },
-                                 keys: ['title']).must_equal 'The Firm'
+        formatted_name({'title'      => 'The Firm',
+                        'author'     => 'John Grisham',
+                        'page count' => 399 },
+                        keys: ['title']).must_equal 'The Firm'
       end
 
       it 'returns result based for multiple keys' do
-        subject.formatted_name({'title'      => 'The Firm',
-                                'author'     => 'John Grisham',
-                                'page count' => '399' },
-                                 sep_char: ':',
-                                 keys: ['title',
-                                        'author',
-                                        'page count']).must_equal 'The Firm:John Grisham:399'
+        formatted_name({'title'      => 'The Firm',
+                        'author'     => 'John Grisham',
+                        'page count' => '399' },
+                        sep_char: ':',
+                        keys: ['title',
+                               'author',
+                               'page count']).must_equal 'The Firm:John Grisham:399'
       end
     end
   end

data/test/test_helper.rb

@@ -3,4 +3,4 @@ require 'minitest/pride'
 require 'minitest-spec-context'
 require 'awesome_print'
 
-require_relative '../lib/ebook_renamer'
+require_relative '../lib/ebook_renamer/helper'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ebook_renamer
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-06 00:00:00.000000000 Z
+date: 2014-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-spec-context
   requirement: !ruby/object:Gem::Requirement
@@ -170,19 +184,15 @@ files:
 - bin/ebook_renamer
 - ebook_renamer.gemspec
 - lib/ebook_renamer.rb
-- lib/ebook_renamer/cli.rb
-- lib/ebook_renamer/configuration.rb
-- lib/ebook_renamer/helpers.rb
+- lib/ebook_renamer/core_ext/hash.rb
+- lib/ebook_renamer/helper.rb
 - lib/ebook_renamer/logger.rb
-- lib/ebook_renamer/options.rb
 - lib/ebook_renamer/version.rb
 - test/fixtures/ebooks/demo1.pdf
 - test/fixtures/ebooks/demo2.epub
 - test/fixtures/ebooks/subdir/demo3.pdf
 - test/fixtures/ebooks/subdir/demo4.epub
-- test/lib/ebook_renamer/configuration_test.rb
 - test/lib/ebook_renamer/helpers_test.rb
-- test/lib/ebook_renamer/version_test.rb
 - test/test_helper.rb
 homepage: https://github.com/agilecreativity/ebook_renamer
 licenses:
@@ -214,8 +224,6 @@ test_files:
 - test/fixtures/ebooks/demo2.epub
 - test/fixtures/ebooks/subdir/demo3.pdf
 - test/fixtures/ebooks/subdir/demo4.epub
-- test/lib/ebook_renamer/configuration_test.rb
 - test/lib/ebook_renamer/helpers_test.rb
-- test/lib/ebook_renamer/version_test.rb
 - test/test_helper.rb
 has_rdoc: 

data/lib/ebook_renamer/cli.rb

@@ -1,60 +0,0 @@
-module EbookRenamer
-  class CLI
-
-    attr_accessor :config
-
-    # Constructor for the class
-    #
-    # @param [Configuration] config the configuration class
-    def initialize(config = Configuration.new)
-      @config = config
-    end
-
-    # Rename the file from the given directory
-    # Using the with the argurment options as follow
-    #   :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']
-    #
-    # @param base_dir [String] base directory default to current directory
-    # @param args [Hash<Symbol, Object>] options argument
-    def rename(base_dir = Dir.pwd, args = {})
-      options = {
-        recursive: false,
-        commit: false,
-        exts: %w(epub mobi pdf).join(",")
-      }.merge(args)
-
-      input_files = Helpers.files(base_dir, options).sort
-
-      unless options[:commit]
-        puts "Changes will not be applied without the --commit option."
-      end
-
-      input_files.each do |file|
-        extension = File.extname(file)
-        begin
-          hash = Helpers.meta_to_hash(Helpers.meta(file, config.meta_binary))
-          formatted_name = Helpers.formatted_name(hash, sep_char: " by ")
-          formatted_name = "#{formatted_name}#{extension}"
-          new_name = "#{File.dirname(file)}/#{Helpers.sanitize_filename(formatted_name, config.sep_string)}"
-          puts "[#{file}] -> [#{new_name}]"
-
-          # TODO: handle this properly!
-          # skip if the filename is too long '228'
-          # see: https://github.com/rails/rails/commit/ad95a61b62e70b839567c2e91e127fc2a1acb113
-          max_allowed_file_size = 220
-          if new_name && new_name.size > max_allowed_file_size
-            puts "FYI: skip file name too long [#{new_name.size}] : #{new_name}"
-            next
-          end
-
-          FileUtils.mv(file,new_name) if options[:commit] && file != new_name && new_name.size < max_allowed_file_size
-        rescue RuntimeError => e
-          puts e.backtrace
-          next
-        end
-      end
-    end
-  end
-end

data/lib/ebook_renamer/configuration.rb

@@ -1,30 +0,0 @@
-module EbookRenamer
-  class Configuration
-    # the separator char for each word in the file name
-    attr_accessor :meta_binary
-
-    # the separator char for each word in the file name
-    attr_accessor :sep_string
-
-    def initialize
-      @meta_binary = 'ebook-meta'
-      @sep_string  = '.'
-    end
-  end
-
-  class << self
-    attr_writer :configuration
-
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    def reset
-      @configuration = Configuration.new
-    end
-
-    def configure
-      yield(configuration)
-    end
-  end
-end

data/lib/ebook_renamer/helpers.rb

@@ -1,175 +0,0 @@
-require 'open3'
-require 'fileutils'
-require 'shellwords'
-
-module EbookRenamer
-  class Helpers
-
-    EbookMetaNotInstall = Class.new(StandardError)
-
-    class << self
-
-      # Extract meta data from the input file using the ebook-meta tool
-      #
-      # @param [String] filename the input file name
-      # @param [String] binary the executable for use to extract the metadata
-      # @return [String] result of the output from running the command
-      def meta(filename, binary = 'ebook-meta')
-        raise EbookMetaNotInstall, "Need to install ebook-meta to use this gem" if which(binary).nil?
-        command = [
-          binary,
-          Shellwords.escape(filename)
-        ]
-
-        stdout_str, stderr_str, status = Open3.capture3(command.join(" "))
-        raise "Problem processing #{filename}" unless status.success?
-        stdout_str
-      end
-
-      # Convert the output string to hash
-      #
-      # @param [String] text output string from the 'ebook-meta' command
-      # @return [Hash<String,String>] hash pair for the input string
-      def meta_to_hash(text)
-        hash = {}
-        return hash if text.nil?
-        result_list = []
-
-        text.split(/\n/).each do |meta|
-          # split by the first ':' string
-          list = meta.split /^(.*?):/
-
-          # ignore the empty string element
-          list.delete_at(0)
-
-          unless list.empty?
-            list.map(&:strip!)
-            # downcase the first item to make it easy
-            result_list << [list[0].downcase, list[1]]
-            hash = Hash[*result_list.flatten]
-          end
-        end
-        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)
-
-        if sep_char
-          # File.basename("demo.txt", ".*") #=> "demo"
-          name_only = File.basename(filename, ".*")
-          # File.extname("demo.txt")        #=> ".txt"
-          ext_only = File.extname(filename)
-          name_only.gsub!(/#{Regexp.quote(dot)}+/, sep_char)
-          return "#{name_only}#{ext_only}"
-        end
-
-        filename.strip
-      end
-
-      # Cross-platform way of finding an executable in the $PATH.
-      #
-      # @param command [String] the command to look up
-      # @return [String, NilClass] full path to the executable file or nil if the
-      #  executable is not valid or available.
-      # Example:
-      #   which('ruby')           #=> /usr/bin/ruby
-      #   which('bad-executable') #=> nil
-      def which(command)
-        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-          exts.each { |ext|
-            exe = File.join(path, "#{command}#{ext}")
-            return exe if File.executable? exe
-          }
-        end
-        return nil
-      end
-
-      # Return formatted file name using the metadata values
-      #
-      # @param [Hash<Symbol,String>] meta_hash output from the program 'ebook-meta' or 'exiftoo'
-      # @param [Hash<Symbol,String>] fields list of fields that will be used to set the name
-      def formatted_name(meta_hash = {}, fields = {})
-        if hash.nil? || fields.nil?
-          raise ArgumentError.new("Argument must not be nil")
-        end
-
-        # The keys that we get from the 'mdls' or 'exiftool'
-        args = {
-          keys: ['title',
-                 'author(s)'],
-          sep_char: ' '
-        }.merge(fields)
-
-        keys = args[:keys]
-        sep_char = args[:sep_char]
-
-        # 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
-          end
-          return result.join(sep_char)
-        end
-        # Note: if no title we choose to return empty value for result
-        return ""
-      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).join(',')
-        }.merge(options)
-
-        raise ArgumentError.new("Invalid directory #{base_dir}") unless File.directory?(base_dir)
-
-        wildcard = args[:recursive] ? '**' : ''
-        patterns = File.join(base_dir, wildcard, "*.{#{args[:exts]}}")
-        Dir.glob(patterns) || []
-      end
-    end
-  end
-end

data/lib/ebook_renamer/options.rb

@@ -1,71 +0,0 @@
-require 'optparse'
-
-module EbookRenamer::Options
-
-  def parse_options()
-    options = {}
-
-    option_parser = OptionParser.new do |opts|
-      opts.banner = <<-END.gsub(/^\s+\|/, '')
-        |
-        | Usage: ebook_renamer [options]
-        |
-        | Examples:
-        |
-        |  1) $ebook_renamer
-        |
-        |  2) $ebook_renamer --base-dir ~/Dropbox/ebooks
-        |
-        |  3) $ebook_renamer --base-dir ~/Dropbox/ebooks
-        |                    --recursive
-        |
-        |  4) $ebook_renamer --base-dir ~/Dropbox/ebooks
-        |                    --recursive
-        |
-        |  5) $ebook_renamer --base-dir ~/Dropbox/ebooks
-        |                    --recursive
-        |                    --commit
-        |
-        |  6) $ebook_renamer --base-dir ~/Dropbox/ebooks
-        |                    --recursive
-        |                    --commit
-        |
-        | Options:
-        |
-      END
-
-      options[:base_dir] ||= Dir.pwd
-      opts.on('-b', '--base-dir directory', 'Starting directory [default - current directory]') do |base_dir|
-        options[:base_dir] = base_dir
-      end
-
-      options[:sep_string] ||= '.'
-      opts.on('-s', '--sep-string string', "Separator string [default - '.']") do |sep_string|
-        options[:sep_string] = sep_string
-      end
-
-      options[:recursive] = false
-      opts.on('-r', '--recursive', 'Process the files recursively [default - false]') do
-        options[:recursive] = true
-      end
-
-      options[:commit] = false
-      opts.on('-c', '--commit', 'Perform the actual rename [default - false]') do
-        options[:commit] = true
-      end
-
-      opts.on('-v', '--version', 'Display version number') do
-        puts EbookRenamer::VERSION
-        exit 0
-      end
-
-      opts.on('-h', '--help', 'Display this screen') do
-        puts opts
-        exit 0
-      end
-    end
-
-    option_parser.parse!
-    options
-  end
-end

data/test/lib/ebook_renamer/configuration_test.rb

@@ -1,22 +0,0 @@
-require_relative '../../test_helper'
-describe EbookRenamer do
-
-  before :each do
-    EbookRenamer.configure do |config|
-      config.meta_binary = 'ebook-meta'
-    end
-  end
-
-  after :each do
-    EbookRenamer.reset
-  end
-
-  it "uses the updated configuration" do
-    EbookRenamer.configuration.meta_binary.must_equal 'ebook-meta'
-    config = EbookRenamer.configure do |config|
-      config.meta_binary = "new-ebook-meta"
-    end
-    EbookRenamer.configuration.meta_binary.must_equal 'new-ebook-meta'
-  end
-
-end

data/test/lib/ebook_renamer/version_test.rb

@@ -1,6 +0,0 @@
-require_relative '../../test_helper'
-describe EbookRenamer do
-  it "must be defined" do
-    EbookRenamer::VERSION.wont_be_nil
-  end
-end