ebook_renamer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b75c163e0bc312d1b720c5545a378cd5ebf61542
-  data.tar.gz: 9afe65913cb1e21c8ebc7f42048c3ef4399b2337
+  metadata.gz: 9e27d4db397905bbe0cf08d76ed4b6d01b4b2a29
+  data.tar.gz: 53bc900783b7757cfdbdd8d6ed632facdd8a9f52
 SHA512:
-  metadata.gz: 84104cd5541f33b0903f2555cf3cd138fe699740a0b2b7d74230307675e218bd90a5b9d7e031ec64a52637f4d425320efe8a43e854c9386c6316683ca747e0c6
-  data.tar.gz: 43c8fd661d4d2d2eb0ff092d9542aabe47a3d0dd63030bf4cb2da6cb3e63e2d89c97f9653740defb78a4f4b27cae3f4f9a7ddc19048dbcfd225bd13c5ec6757d
+  metadata.gz: c04360a30e7491e5704d51ed7140146f805a11062f8deab049988ef7a0ef1e8fe7e7d30258abe683b9ce0d81d5d0eeef0dcafde5fb5673a2aa62e16e7d722462
+  data.tar.gz: 22ce0baff5a0bdc51ff3e422ef8f9c2e8aa45d8c20d45a7a142483f20519d04a148b7acd92c5e49b0603d2262c8510346f2cbfb7bacdf1c633e30470d90107f4

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ebook_renamer.gemspec
 gemspec
+
+gem 'code_lister', '~> 0.0.6'

data/README.md

@@ -2,17 +2,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/ebook_renamer.svg)](http://badge.fury.io/rb/ebook_renamer)
 
-Simple utility to perform bulk rename of ebook files (epub,mobi,pdf) based on
-the embedded meta-data (title, author(s)).
-
-### Why do I wrote this gem
-
-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 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.
+Perform bulk rename of ebook files (epub,mobi,pdf, and any other extensions supported by Calibre)
+based on the embedded meta-data (title, author(s)).
 
 ### How the file is renamed
 
@@ -22,16 +13,21 @@ Also the final file name will be sanitized e.g. any multiple occurence of specia
 replace by one dot `.`.
 
 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`
+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.
+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`.
 
 ### 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) on your OS.
 
+  In particular the gem is looking for the `ebook-meta` binary in a path.
+  If this is not installed the error will be raised.
+
 * Linux or Mac OSX operating system
 
 ### Installation and Usage:
@@ -83,28 +79,40 @@ test/fixtures/
 Run the command without making any changes
 
 ```sh
-./bin/ebook_renamer rename --base-dir ./test/fixtures/ebooks --recursive
+ebook_renamer rename --base-dir -e epub pdf ./test/fixtures/ebooks --recursive
 ```
 
 You should see the result like the following
 
 ```
-Your argument: {:base_dir=>".", :exts=>["pdf", "epub", "mobi"], :sep_string=>".", :commit=>false, :recursive=>true, :version=>false}
+Your options :{:base_dir=>"test/fixtures/ebooks/",
+               :exts=>["epub", "pdf"],
+               :non_exts=>[],
+               :inc_words=>[],
+               :exc_words=>[],
+               :ignore_case=>true,
+               :recursive=>true,
+               :version=>false,
+               :sep_string=>".",
+               :commit=>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]
+
+[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 make the actual rename just pass in the `--commit` option like
+To actually make the actual rename just pass in the `--commit` option like so:
 
 ```sh
-./bin/ebook_renamer rename --base-dir ./test/fixtures/ebooks --recursive --commit
-./bin/ebook_renamer rename -b ./test/fixtures/ebooks -r -c
+./bin/ebook_renamer rename --base-dir ./test/fixtures/ebooks -e epub pdf --recursive --commit
+# or short version
+./bin/ebook_renamer rename -b ./test/fixtures/ebooks -e epub pdf -r -c
 ```
 
-The final output should be like
+The final output should be something like:
 
 ```
 test/fixtures/
@@ -119,30 +127,43 @@ test/fixtures/
 
 ### Sample Usage
 
+To get the help just type `ebook_renamer` without any argument
+
 ```
 Usage:
-  ebook_renamer rename
+  ebook_renamer rename [OPTIONS]
 
 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)
+  -b, [--base-dir=BASE_DIR]                # Base directory
+                                           # Default: . (current directory)
+  -e, [--exts=one two three]               # List of extensions to search for
+  -f, [--non-exts=one two three]           # List of files without extension to search for
+  -n, [--inc-words=one two three]          # List of words to be included in the result if any
+  -x, [--exc-words=one two three]          # List of words to be excluded from the result if any
+  -i, [--ignore-case], [--no-ignore-case]  # Match case insensitively
+                                           # Default: true
+  -r, [--recursive], [--no-recursive]      # Search for files recursively
+                                           # Default: true
+  -v, [--version], [--no-version]          # Display version information
+  -s, [--sep-string=SEP_STRING]            # Separator string between words in filename
+                                           # Default: .
+  -c, [--commit], [--no-commit]            # Make change permanent
+
+Rename multiple ebook files (pdf,epub,mobi)
 ```
 
 ### Changelog
 
+#### 0.1.1
+
+- Make use of the 'code_lister' for better options [see: `ebook_renamer` for detail]
+- The --exts must be specified explicitly as `code_lister` is not set any extension by default.
+
 #### 0.1.0
 
 - Add link to the version badge to link to latest gem.
-- Minor clean-up
+- Implicitly set the default value for extension to `pdf,epub,mobi` if
+  not explicitly set by the user at the command line.
 
 #### 0.0.9
 

data/Rakefile

@@ -9,16 +9,6 @@ end
 
 task :default => :test
 
-task :irb do
-  require 'irb'
-  require 'awesome_print'
-  require 'irb/completion'
-  require 'ebook_renamer'
-  include EbookRenamer
-  ARGV.clear
-  IRB.start
-end
-
 task :pry do
   require 'pry'
   require 'awesome_print'

data/bin/ebook_renamer

@@ -1,8 +1,4 @@
 #!/usr/bin/env ruby
-require 'thor'
 require_relative '../lib/ebook_renamer'
-require_relative '../lib/ebook_renamer/helper'
-require_relative '../lib/ebook_renamer/version'
-
 include EbookRenamer
-EbookRenamer::Command.start(ARGV)
+EbookRenamer::CLI.start(ARGV)

data/ebook_renamer.gemspec

@@ -18,10 +18,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "thor", "~> 0.18"
-  spec.add_runtime_dependency "awesome_print", "~> 1.2"
+  spec.add_runtime_dependency "code_lister", "~> 0.0.6"
 
   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", "~> 4.2"

data/lib/ebook_renamer.rb

@@ -1,129 +1,7 @@
 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 "You are using ebook_renamer version #{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
+require 'code_lister'
+require_relative 'ebook_renamer/core_ext/hash'
+require_relative 'ebook_renamer/version'
+require_relative 'ebook_renamer/logger'
+require_relative 'ebook_renamer/helper'
+require_relative 'ebook_renamer/cli'

data/lib/ebook_renamer/cli.rb

@@ -0,0 +1,103 @@
+require 'code_lister'
+require_relative '../ebook_renamer'
+
+module EbookRenamer
+  class CLI < CodeLister::BaseCLI
+    desc 'rename', 'Rename multiple ebook files (pdf,epub,mobi)'
+
+    shared_options
+
+    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
+    def rename
+      opts = options.symbolize_keys
+
+      # Note: by default the 'code_lister' for exts: is [].
+      # To make it more user friendly, we explicitly set the extension
+      # to %w(pdf epub mobi) to avoid the need for explicit value by the user
+      opts[:exts] = %w(pdf epub mobi) if opts.fetch(:exts, []).empty?
+
+      if opts[:version]
+        puts "You are using EbookRenamer version #{EbookRenamer::VERSION}"
+        exit
+      end
+      execute(opts)
+    end
+
+    desc "usage", "Display help screen"
+    def usage
+      puts <<-EOS
+Usage:
+  cli.rb rename [OPTIONS]
+
+Options:
+  -b, [--base-dir=BASE_DIR]                # Base directory
+                                           # Default: /Users/agilecreativity/Dropbox/spikes/ebooks-renamer
+  -e, [--exts=one two three]               # List of extensions to search for
+  -f, [--non-exts=one two three]           # List of files without extension to search for
+  -n, [--inc-words=one two three]          # List of words to be included in the result if any
+  -x, [--exc-words=one two three]          # List of words to be excluded from the result if any
+  -i, [--ignore-case], [--no-ignore-case]  # Match case insensitively
+                                           # Default: true
+  -r, [--recursive], [--no-recursive]      # Search for files recursively
+                                           # Default: true
+  -v, [--version], [--no-version]          # Display version information
+  -s, [--sep-string=SEP_STRING]            # Separator string between words in filename
+                                           # Default: .
+  -c, [--commit], [--no-commit]            # Make change permanent
+
+Rename multiple ebook files (pdf,epub,mobi)
+      EOS
+    end
+
+    default_task :usage
+
+    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(options = {})
+      meta_binary = "ebook-meta"
+
+      input_files = CodeLister.files(options)
+
+      if input_files.empty?
+        puts "No file found for your option: #{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
+  end
+end

data/lib/ebook_renamer/core_ext/hash.rb

@@ -33,4 +33,24 @@ class Hash
     transform_keys!{ |key| key.to_sym rescue key }
   end
 
+  # Merges the caller into +other_hash+. For example,
+  #
+  #   options = options.reverse_merge(size: 25, velocity: 10)
+  #
+  # is equivalent to
+  #
+  #   options = { size: 25, velocity: 10 }.merge(options)
+  #
+  # This is particularly useful for initializing an options hash
+  # with default values.
+  def reverse_merge(other_hash)
+    other_hash.merge(self)
+  end
+
+  # Destructive +reverse_merge+.
+  def reverse_merge!(other_hash)
+    # right wins if there is no left
+    merge!(other_hash) { |key,left,right| left }
+  end
+
 end

data/lib/ebook_renamer/helper.rb

@@ -1,7 +1,8 @@
 require 'open3'
 require 'fileutils'
 require 'shellwords'
-require_relative "./core_ext/hash"
+require_relative '../ebook_renamer'
+
 module EbookRenamer
 
   EbookMetaNotInstall = Class.new(StandardError)

data/lib/ebook_renamer/version.rb

@@ -1,3 +1,3 @@
 module EbookRenamer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 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/helper'
+require_relative '../lib/ebook_renamer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ebook_renamer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-11 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.18'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: code_lister
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !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: minitest-spec-context
   requirement: !ruby/object:Gem::Requirement
@@ -184,15 +198,16 @@ files:
 - bin/ebook_renamer
 - ebook_renamer.gemspec
 - lib/ebook_renamer.rb
+- lib/ebook_renamer/cli.rb
 - lib/ebook_renamer/core_ext/hash.rb
 - lib/ebook_renamer/helper.rb
 - lib/ebook_renamer/logger.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/helpers_test.rb
+- test/fixtures/ebooks/subdir/demo1.pdf
+- test/fixtures/ebooks/subdir/demo2.epub
+- test/lib/ebook_renamer/helper_test.rb
 - test/test_helper.rb
 homepage: https://github.com/agilecreativity/ebook_renamer
 licenses:
@@ -222,8 +237,8 @@ summary: Rename multiple ebook files (pdf, epub, mobi) based on existing meta-da
 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/helpers_test.rb
+- test/fixtures/ebooks/subdir/demo1.pdf
+- test/fixtures/ebooks/subdir/demo2.epub
+- test/lib/ebook_renamer/helper_test.rb
 - test/test_helper.rb
 has_rdoc: