ebook_renamer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 244dbff6a80aa66460a633d9ca1e77d7c2d11054
+  data.tar.gz: 7db39857c19b170eb76ea19d62cd85a444505c77
+SHA512:
+  metadata.gz: b1d5b29908281d629b7e6dbdab770b8a59902caf6c985332e5cce282389b963c0359d321683194c698a3a74b90d5b9899e02b3a3350f06c7303a8b9c5e274bf8
+  data.tar.gz: 57536decad2872912f5c507de4de1fb04d7fa2b5b590353ce6255a78a5128688d841a48a58fb44a4a3988dc4dce8f4b9ef4b567734d04923d84a8418ee75fe6e

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+## Note for testing only!!
+misc/

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.yardopts

@@ -0,0 +1,2 @@
+# see: http://rubydoc.info/gems/yard/file/README.md
+--no-private --protected lib/**/*.rb - README.md LICENSE

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ebook_renamer.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/(.*)\/?test_(.*)\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  # watch(%r|^spec/(.*)_spec\.rb|)
+  # watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  # watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+
+  # Rails 3.2
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/controllers/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }
+
+  # Rails
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Burin Choomnuan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+## EbookRenamer
+
+Simple utility to perform bulk rename of the ebooks(epub,mobi,pdf) based on
+the metadata within the ebook itself (if available).
+
+### Installation
+
+* You will need to install the [Calibre](http://www.calibre-ebook.com/) and
+  [Calibre CLI](http://manual.calibre-ebook.com/cli/cli-index.html)
+
+* Then install the gem
+
+```sh
+$bundle
+$gem install ebook_renamer
+```
+
+### Usage
+
+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/
+
+# or specify the directory as an option
+ebook_renamer --base-dir ~/Dropbox/ebooks/samples
+
+# If you like to see the usage try
+ebook_renamer --help
+
+# Run the command without to see what will be changed without making any changes (dry-run)
+ebook_rename  --recursive
+
+# Once you are happy with what you see, then
+ebook_renamer --recusive --commit
+```
+
+### Output of `ebook_renamer --help`
+
+```
+ 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
+ Options:
+
+    -b, --base-dir directory         Starting directory [default - current directory]
+    -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
+```
+
+### Contributing
+
+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. Make sure that you add the tests and ensure that all tests are passed
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,31 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/ebook_renamer'
+  t.test_files = FileList['test/lib/ebook_renamer/*_test.rb']
+  t.verbose = true
+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'
+  require 'irb/completion'
+  require 'ebook_renamer'
+  include EbookRenamer
+  ARGV.clear
+  IRB.start
+end
+
+## see: http://lucapette.com/pry/pry-everywhere/
+task :pry do
+  require 'pry'
+  require 'awesome_print'
+  require 'ebook_renamer'
+  include EbookRenamer
+  ARGV.clear
+  Pry.start
+end

data/bin/ebook_renamer

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+begin
+  require 'pry'
+  require 'ebook_renamer'
+rescue LoadError
+  $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+  require 'ebook_renamer'
+end
+
+include EbookRenamer
+include EbookRenamer::Options
+require 'ostruct'
+
+begin
+  options = parse_options()
+  EbookRenamer.logger.info "Your options: #{options}"
+  # Note: if we need to adjust the path to the executable
+  EbookRenamer.configure do |config|
+    config.meta_binary = '/usr/bin/ebook-meta'
+  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

data/ebook_renamer.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ebook_renamer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ebook_renamer"
+  spec.version       = EbookRenamer::VERSION
+  spec.authors       = ["Burin Choomnuan"]
+  spec.email         = ["agilecreativity@gmail.com"]
+  spec.description   = %q{Bulk rename of ebook files based on available metadata}
+  spec.summary       = %q{Rename multiple ebook files (epub, mobi, pdf) based on existing metadata in the file}
+  spec.homepage      = "https://github.com/agilecreativity/ebook_renamer"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  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"]
+  # Generated dependencies
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  # additional dependencies
+  spec.add_development_dependency "minitest-spec-context", "~> 0.0.3"
+  spec.add_development_dependency "guard-minitest", "~> 2.2"
+  spec.add_development_dependency "minitest", "~> 4.2"
+  spec.add_development_dependency "awesome_print", "~> 1.2"
+  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"
+end

data/lib/ebook_renamer.rb

@@ -0,0 +1,7 @@
+require 'ebook_renamer/version'
+require 'ebook_renamer/logger'
+require 'ebook_renamer/constant'
+require 'ebook_renamer/helpers'
+require 'ebook_renamer/configuration'
+require 'ebook_renamer/options'
+require 'ebook_renamer/cli'

data/lib/ebook_renamer/cli.rb

@@ -0,0 +1,54 @@
+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
+
+      input_files.each do |file|
+        puts "Input :#{file}"
+        extension = File.extname(file)
+        begin
+          hash = Helpers.meta_to_hash(Helpers.meta(file, config.ebook_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, '.')}"
+          puts "Output:#{new_name}"
+          # skip if the filename is too long '228'
+          # see: https://github.com/rails/rails/commit/ad95a61b62e70b839567c2e91e127fc2a1acb113
+          # @todo find out the max file size
+          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

@@ -0,0 +1,32 @@
+module EbookRenamer
+  class Configuration
+
+    attr_accessor :meta_binary
+
+    def initialize
+      @meta_binary = '/usr/bin/ebook-meta'
+    end
+
+    def to_s
+      <<-END.gsub(/^\s+\|/, '')
+       | ebook-meta : #{ebook_meta_binary}
+      END
+    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/constant.rb

@@ -0,0 +1,19 @@
+module EbookRenamer
+  # The Calibre metadata extraction tool (epub, mobi)
+  CALIBRE_CLI_BINARY = '/usr/bin/ebook-meta'
+
+  # The Calibre metadata extraction tool
+  CALIBRE_META_CLI = '/usr/bin/ebook-meta'
+
+  # Support URL for Calibre's CLI tool
+  CALIBRE_CLI_URL = 'http://manual.calibre-ebook.com/cli/cli-index.html'
+
+  # Exiftool binary executable (for pdf, also `mdls` on OSX)
+  EXIFTOOL_BINARY = '/usr/local/bin/exiftool'
+
+  # On OSX, `brew install exiftool`
+  EXIFTOOL_URL = 'http://www.sno.phy.queensu.ca/~phil/exiftool/'
+
+  # Attribute keys
+  META_KEYS = %w[title authors(s) publisher languages published rights identifiers]
+end

data/lib/ebook_renamer/helpers.rb

@@ -0,0 +1,171 @@
+require 'open3'
+require 'fileutils'
+require 'shellwords'
+
+module EbookRenamer
+  class Helpers
+    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')
+        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/logger.rb

@@ -0,0 +1,10 @@
+require 'logger'
+module EbookRenamer
+  class << self
+    attr_writer :logger
+      # @return [Logger] the Logger for the project
+      def logger
+        @logger ||= Logger.new STDOUT
+      end
+  end
+end

data/lib/ebook_renamer/options.rb

@@ -0,0 +1,62 @@
+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
+        |
+        | 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[: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/lib/ebook_renamer/version.rb

@@ -0,0 +1,3 @@
+module EbookRenamer
+  VERSION = "0.0.1"
+end

data/test/lib/ebook_renamer/configuration_test.rb

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

data/test/lib/ebook_renamer/helpers_test.rb

@@ -0,0 +1,123 @@
+require_relative '../../test_helper'
+describe EbookRenamer do
+
+  subject { EbookRenamer::Helpers }
+
+  before do
+    @sample = EbookRenamer::Helpers.meta("./test/fixtures/ebooks/demo1.pdf")
+  end
+
+  context "#meta" do
+    it "raises error on invalid input" do
+      ->{ subject.meta("invalid-filename") }.must_raise RuntimeError
+    end
+
+    it "returns valid valid input" do
+      @sample.wont_be_nil
+    end
+
+  end
+
+  context "#meta_to_hash" do
+    it 'returns empty hash' do
+      subject.meta_to_hash(nil).must_be_empty
+    end
+    it 'returns non-empty hash' do
+      hash = EbookRenamer::Helpers.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({})
+      end
+    end
+
+    describe 'valid format' do
+      # extract list of 'key' : 'value' from the input
+      let(:sample) {
+        <<-END
+        Aaaa : BBbb
+        CcCc : DddD
+        EeeE : FFFF:gggg
+        hhhh : iiii:JJJJ:kkkk
+        END
+      }
+
+      let(:result) { subject.meta_to_hash(sample) }
+
+      it "returns proper type for result" do
+        result.must_be_instance_of Hash
+      end
+
+      it 'uses lowercase for result keys' do
+        result.keys.must_equal ['aaaa','cccc','eeee','hhhh']
+      end
+
+      it 'retains original cases for result values' do
+        result.values.must_equal ['BBbb','DddD','FFFF:gggg','iiii:JJJJ:kkkk']
+      end
+    end
+  end
+
+  context "#sanitize_filename" do
+    it "must be defined" do
+      subject.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')
+    end
+
+    it "replaces multiple valid chars with one" do
+      subject.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')
+    end
+  end
+
+  context '#which' do
+    describe 'valid executable' do
+      it 'works with valid executable' do
+        subject.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
+      end
+    end
+  end
+
+  context '#formatted_name' do
+    describe 'invalid parameters' do
+      it 'raises exception on nil arguments' do
+        -> { subject.formatted_name({}, nil)}.must_raise ArgumentError
+      end
+      it 'returns nil on empty hash' do
+        subject.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'
+      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'
+      end
+    end
+  end
+end

data/test/lib/ebook_renamer/version_test.rb

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

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest-spec-context'
+require 'awesome_print'
+
+require_relative '../lib/ebook_renamer'

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: ebook_renamer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Burin Choomnuan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: gem-ctags
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Bulk rename of ebook files based on available metadata
+email:
+- agilecreativity@gmail.com
+executables:
+- ebook_renamer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".yardopts"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/ebook_renamer
+- ebook_renamer.gemspec
+- lib/ebook_renamer.rb
+- lib/ebook_renamer/cli.rb
+- lib/ebook_renamer/configuration.rb
+- lib/ebook_renamer/constant.rb
+- lib/ebook_renamer/helpers.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:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rename multiple ebook files (epub, mobi, pdf) based on existing metadata
+  in the file
+test_files:
+- 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
+has_rdoc: