ebook_renamer 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0073243419f6aa7db6891e2b72250c69b5d0e3a1
-  data.tar.gz: 596bdb43d250f6eb5e71cad01fcc02fcabdcfac9
+  metadata.gz: 0c2b2bf7c2b9d1e2920c4634db1c348ec8db3fda
+  data.tar.gz: df92456b316428948cd8d27eb9a9765da785243a
 SHA512:
-  metadata.gz: 1bdef075f46875f900348fbfc4e1740230fe702647dc7ff08660c6da30958b1311e29b3226e444dc3d239e25131f0202611ba2f9b392f58cf34aac6d4d1b545f
-  data.tar.gz: f5330df3267139a9c0f0f0041c0e6a9d6fd69f0e94e550adbbeaaaa8ce556fa136dc6265c25904b3005cf529c49e9474f2d10edbe3bc5948ae60c1a60e8bac19
+  metadata.gz: 39c8b4cbf1b95036c45c693a3bf37fb371ad3222dc40a715ba81e84e8cdec072e2ad7b7f39910309b1bb21df2b0c9a91a5567dc38875bf5a50619fc5ec4f12b1
+  data.tar.gz: b67d518a78608658c0f6defe6fe2eb58351746da8927f4efb873d2e230d936493d48803f2273d3b968c4d08dfdba0e54347c9402099025dbeccd3eee7576017a

data/README.md

@@ -1,14 +1,36 @@
-## EbookRenamer
+## Ebook_Renamer
 
 Simple utility to perform bulk rename of the ebooks(epub,mobi,pdf) based on
 the metadata within the ebook itself (if available).
 
-### Installation
+### Why do I wrote this gem
+
+Almost alwasy when I purchase a new ebooks (or download them from the internet) they always came with the
+bad name. I really like the meaningful name to the file that I have. This make it easy to search for them
+and give you the context to the content of the file.
+
+I wrote this gem just to make it possible to rename in bulk and recursively.
+
+This gem will rename any ebook files (currently only pdf, epub, mobi) using the available
+meta-data that embedded within the ebook.
+
+So if you don't like to spend time renaming them manually then this gem is for you.
+
+### What you will need
 
 * You will need to install the [Calibre](http://www.calibre-ebook.com/) and
-  [Calibre CLI](http://manual.calibre-ebook.com/cli/cli-index.html)
+  [Calibre CLI](http://manual.calibre-ebook.com/cli/cli-index.html) on your OS.
 
-* Then install the gem
+* This gem should work on OSX/Linux like system. It may work with Windows system but I can't confirm
+as I don't use windows for quite sometime now.
+
+### 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
 bundle
@@ -37,7 +59,7 @@ ebook_rename  --recursive
 ebook_renamer --recusive --commit
 ```
 
-### Output of `ebook_renamer --help`
+### Sample Usage (from `ebook_renamer --help`)
 
 ```
  Usage: ebook_renamer [options]
@@ -57,15 +79,35 @@ ebook_renamer --recusive --commit
   5) $ebook_renamer --base-dir ~/Dropbox/ebooks
                     --recursive
                     --commit
+
+  6) $ebook_renamer --base-dir ~/Dropbox/ebooks
+                    --meta-binary /usr/bin/ebook-meta
+                    --recursive
+                    --commit
+
  Options:
 
     -b, --base-dir directory         Starting directory [default - current directory]
+    -m, --meta-binary path           Path to the ebook-meta executable [default - '/usr/bin/ebook-meta']
     -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
 ```
 
+### Changelog
+
+#### 0.0.3
+
+- make it possible to change the path to the binary
+
+#### 0.0.2
+
+- fix the silly refactoring bug
+
+#### 0.0.1
+- Initial release
+
 ### Contributing
 
 1. Fork it

data/bin/ebook_renamer

@@ -14,9 +14,12 @@ require 'ostruct'
 begin
   options = parse_options()
   EbookRenamer.logger.info "Your options: #{options}"
+  meta_binary = options.delete(:meta_binary)
+  #
   # Note: if we need to adjust the path to the executable
   EbookRenamer.configure do |config|
-    config.meta_binary = '/usr/bin/ebook-meta'
+    #config.meta_binary = '/usr/bin/ebook-meta'
+    config.meta_binary = meta_binary unless meta_binary.nil?
   end
 
   cli = EbookRenamer::CLI.new(EbookRenamer.configuration)

data/lib/ebook_renamer/helpers.rb

@@ -4,6 +4,9 @@ require 'shellwords'
 
 module EbookRenamer
   class Helpers
+
+    EbookMetaNotInstall = Class.new(StandardError)
+
     class << self
 
       # Extract meta data from the input file using the ebook-meta tool
@@ -12,8 +15,12 @@ module EbookRenamer
       # @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')
+        binary_path = which(binary)
+
+        raise EbookMetaNotInstall, "Need to install ebook-meta to use this gem" if binary_path.nil?
+
         command = [
-          binary,
+          binary_path,
           Shellwords.escape(filename)
         ]
 

data/lib/ebook_renamer/options.rb

@@ -26,6 +26,11 @@ module EbookRenamer::Options
         |                    --recursive
         |                    --commit
         |
+        |  6) $ebook_renamer --base-dir ~/Dropbox/ebooks
+        |                    --meta-binary /usr/bin/ebook-meta
+        |                    --recursive
+        |                    --commit
+        |
         | Options:
         |
       END
@@ -35,6 +40,11 @@ module EbookRenamer::Options
         options[:base_dir] = base_dir
       end
 
+      options[:meta_binary] ||= '/usr/bin/ebook-meta'
+      opts.on('-m', '--meta-binary path', "Path to the ebook-meta executable [default - '/usr/bin/ebook-meta']") do |binary|
+        options[:meta_binary] = binary
+      end
+
       options[:recursive] = false
       opts.on('-r', '--recursive', 'Process the files recursively [default - false]') do
         options[:recursive] = true

data/lib/ebook_renamer/version.rb

@@ -1,3 +1,3 @@
 module EbookRenamer
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ebook_renamer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-04 00:00:00.000000000 Z
+date: 2014-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler