ebook_renamer 0.2.2 → 0.2.3

data/CHANGELOG.md

@@ -1,4 +1,9 @@
 ### Changelog
+#### 0.2.3
+
+- Use `require` instead of `require_relative` when possible
+- Use underscore instead of dot as the default seperator
+- Improve README.md
 
 #### 0.2.2
 

data/README.md

@@ -33,9 +33,9 @@ If the `--sep-string _` is used then the above output will be
 ### What you will need
 
 - You will need to install [Calibre][] and
-  [Calibre CLI][] on your OS. Please download Calibre binary from [http://calibre-ebook.com/download](http://calibre-ebook.com/download)
+  [Calibre CLI][] on your OS. Please download Calibre binary from [http://calibre-ebook.com/download][]
 
-Alternatively if Ubuntu Linux:
+Alternatively if you are using Ubuntu try:
 
 ```shell
 sudo apt-get install calibre calibre-bin
@@ -67,7 +67,7 @@ Options:
   -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)
+                                         # Default: '_' (underscore)
   -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
@@ -178,6 +178,11 @@ ebook_renamer --base-dir . --sep-string '_' --recursive --capitalize --commit
 
 will produce the result filename like `Start_With_Why_How_Great_Leader_Inspire_Everyone_To_Take_Action_by_Simon_Sinek.pdf`.
 
+### Alternative
+
+- Check out my other gem called [ebooks_renamer][] which provides similar functionality but implemented in pure ruby.
+- [ebooks_renamer][] does not rely on the external software like [Calibre CLI][] to be install before use!
+
 ### Contributing
 
 1. Fork it
@@ -189,4 +194,6 @@ will produce the result filename like `Start_With_Why_How_Great_Leader_Inspire_E
 
 [Calibre]: http://www.calibre-ebook.com/
 [Calibre CLI]: http://manual.calibre-ebook.com/cli/cli-index.html
+[http://calibre-ebook.com/download]: http://calibre-ebook.com/download
+[ebooks_renamer]: http://rubygems.org/gems/ebooks_renamer
 [Semantic Versioning]: http://semver.org

data/ebook_renamer.gemspec

@@ -2,14 +2,13 @@
 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 (pdf, epub, mobi) based on embedded metadata}
-  spec.summary       = %q{Rename multiple ebook files (pdf, epub, mobi) based on existing metadata if available}
+  spec.summary       = %q{Rename multiple ebook files (pdf, epub, mobi) based on embedded metadata (if available)}
   spec.homepage      = "https://github.com/agilecreativity/ebook_renamer"
   spec.license       = "MIT"
   spec.required_ruby_version = ">= 1.9.3"
@@ -24,21 +23,19 @@ Gem::Specification.new do |spec|
   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.1"
-  spec.add_runtime_dependency "agile_utils", "~> 0.2.2"
-  spec.add_runtime_dependency "code_lister", "~> 0.2.2"
-  spec.add_runtime_dependency "filename_cleaner", "~> 0.4.3"
-
-  spec.add_development_dependency "bundler", "~> 1.7.0"
+  spec.add_runtime_dependency "agile_utils", "~> 0.2.3"
+  spec.add_runtime_dependency "code_lister", "~> 0.2.4"
+  spec.add_runtime_dependency "filename_cleaner", "~> 0.4.6"
+  spec.add_development_dependency "bundler", "~> 1.7.3"
   spec.add_development_dependency "rake", "~> 10.3.2"
   spec.add_development_dependency "awesome_print", "~> 1.2.0"
   spec.add_development_dependency "minitest-spec-context", "~> 0.0.3"
   spec.add_development_dependency "guard-minitest", "~> 2.3.1"
-  spec.add_development_dependency "minitest", "~> 5.4.0"
+  spec.add_development_dependency "minitest", "~> 5.4.2"
   spec.add_development_dependency "guard", "~> 2.6.1"
-  spec.add_development_dependency "pry", "~> 0.10.0"
+  spec.add_development_dependency "pry", "~> 0.10.1"
   spec.add_development_dependency "gem-ctags", "~> 1.0.6"
   spec.add_development_dependency "yard", "~> 0.8.7"
-  spec.add_development_dependency "rubocop", "~> 0.24.1"
+  spec.add_development_dependency "rubocop", "~> 0.26.1"
 end

data/lib/ebook_renamer.rb

@@ -1,6 +1,11 @@
 require "thor"
-require "code_lister"
+require "open3"
+require "fileutils"
+require "shellwords"
 require "agile_utils"
-require_relative "ebook_renamer/version"
-require_relative "ebook_renamer/ebook_renamer"
-require_relative "ebook_renamer/cli"
+require "filename_cleaner"
+require "code_lister"
+require "ebook_renamer/version"
+require "ebook_renamer/errors"
+require "ebook_renamer/ebook_renamer"
+require "ebook_renamer/cli"

data/lib/ebook_renamer/cli.rb

@@ -1,8 +1,3 @@
-require "agile_utils"
-require "code_lister"
-require "filename_cleaner"
-require "fileutils"
-require_relative "../ebook_renamer"
 module EbookRenamer
   class CLI < Thor
     desc "rename", "Rename multiple ebook files (pdf,epub,mobi) from a given directory"
@@ -11,7 +6,7 @@ module EbookRenamer
     method_option :sep_string,
                   aliases: "-s",
                   desc: "Separator string between each word in output filename",
-                  default: "."
+                  default: "_"
     method_option :downcase,
                   aliases: "-d",
                   type: :boolean,
@@ -42,7 +37,6 @@ module EbookRenamer
     desc "usage", "Display help screen"
     def usage
       puts <<-EOS
-
 Usage:
   ebook_renamer
 
@@ -52,7 +46,7 @@ Options:
   -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)
+                                         # Default: '_' (underscore)
   -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

data/lib/ebook_renamer/ebook_renamer.rb

@@ -1,17 +1,11 @@
-require "open3"
-require "fileutils"
-require "shellwords"
-require_relative "../ebook_renamer"
 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")
-    fail EbookMetaNotInstall, "Need to install ebook-meta to use this gem" if AgileUtils::Helper.which(binary).nil?
+    fail Errors::EbookMetaNotInstall, "Need to install ebook-meta to use this gem" if AgileUtils::Helper.which(binary).nil?
     command = [
       binary,
       Shellwords.escape(filename)

data/lib/ebook_renamer/errors.rb

@@ -0,0 +1,5 @@
+module EbookRenamer
+  module Errors
+    EbookMetaNotInstall = Class.new(StandardError)
+  end
+end

data/lib/ebook_renamer/version.rb

@@ -1,3 +1,3 @@
 module EbookRenamer
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ebook_renamer
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-14 00:00:00.000000000 Z
+date: 2014-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: code_lister
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: filename_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.4.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.4.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.7.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.7.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -162,7 +162,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 5.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -170,7 +170,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 5.4.2
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -194,7 +194,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -202,7 +202,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: gem-ctags
   requirement: !ruby/object:Gem::Requirement
@@ -242,7 +242,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.24.1
+        version: 0.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -250,7 +250,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.24.1
+        version: 0.26.1
 description: Bulk rename of ebook files (pdf, epub, mobi) based on embedded metadata
 email:
 - agilecreativity@gmail.com
@@ -262,6 +262,7 @@ files:
 - bin/ebook_renamer
 - lib/ebook_renamer/cli.rb
 - lib/ebook_renamer/ebook_renamer.rb
+- lib/ebook_renamer/errors.rb
 - lib/ebook_renamer/version.rb
 - lib/ebook_renamer.rb
 - Gemfile
@@ -296,7 +297,7 @@ rubyforge_project:
 rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
-summary: Rename multiple ebook files (pdf, epub, mobi) based on existing metadata
-  if available
+summary: Rename multiple ebook files (pdf, epub, mobi) based on embedded metadata
+  (if available)
 test_files: []
 has_rdoc: