ebook_renamer 0.1.12 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9ef7405b620681debaedb895824705a3dadf3f6
-  data.tar.gz: 64dcd10441db07e72207958a0401927416e8228e
+  metadata.gz: 984d40f8f75497e23af8e38cbe890f7677d4ace1
+  data.tar.gz: 0dbec0f3ce367616c3d2590e70e399d5c289be21
 SHA512:
-  metadata.gz: 18155ce3c48ec30026b599391cc5579e17a8e3938e60c44c163e1b05990c1d573f68e98188407e86a67a143b05ed98706ced0afaf7152a7b202838c2ea78e390
-  data.tar.gz: 87a9b9574a114a0dddbb1ddd89ff86d2cde8a36288553b15c301d3e2bf98c08ccc9ce4b5d9988636b3eb1c1c585349bd50e40af059a250f02634621b8bdbe895
+  metadata.gz: dcffe1929a309553c068af946567305f782609e8056cf773e17e43932ec779b6a34a65fb0b030cf21c2752a16003ba0d996b4a1a4882dc857bf716b83e48d4c2
+  data.tar.gz: e5ac5fe5ec9cc12e9c8f3ad1b72e1584172d49f349e0ad24ac456eb8569e1351016efd056a7ef708903bbd39736eed86f13f88c6650a1e4281a7f275faf9f02c

data/.rubocop.yml

@@ -27,12 +27,6 @@ CollectionMethods:
     find:     'detect'
     find_all: 'select'
 
-# Do not force public/protected/private keyword to be indented at the same
-# level as the def keyword. My personal preference is to outdent these keywords
-# because I think when scanning code it makes it easier to identify the
-# sections of code and visually separate them. When the keyword is at the same
-# level I think it sort of blends in with the def keywords and makes it harder
-# to scan the code and see where the sections are.
 AccessModifierIndentation:
   Enabled: false
 
@@ -60,10 +54,6 @@ DotPosition:
 Encoding:
   Enabled: false
 
-# Enforce outdenting of access modifiers (i.e. public, private, protected)
-AccessModifierIndentation:
-  EnforcedStyle: outdent
-
 EmptyLinesAroundAccessModifier:
   Enabled: true
 

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ### Changelog
 
+#### 0.2.0
+
+- Make use of refinement instead of monkeypatching core classes
+- Minor code cleanup
+
 #### 0.1.12
 
 - Skip the file if the result filename exist locally.

data/README.md

@@ -9,36 +9,44 @@ ebook_renamer
 [gemnasium]: https://gemnasium.com/agilecreativity/ebook_renamer
 [codeclimate]: https://codeclimate.com/github/agilecreativity/ebook_renamer
 
-Perform bulk rename of ebook files (epub,mobi,pdf) based on the embedded metadata (title, author(s)).
+Bulk rename of ebook files (epub,mobi,pdf) using embedded meta-data (title, author(s)).
 This version depends on the opensource software called [Calibre][] that comes
 with [Calibre CLI][] which is very easy to install on OSX or Linux system.
 
-Note: start from version `0.1.7` this gem will release based on [Semantic Versioning][] version.
+Release based on [Semantic Versioning][] version.
 
 ### How the file is renamed
 
 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 multiple occurence of special characters will be
-replace by one dot `.`.
+replace by given separator char (default to 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`
-Note that the `:` and one space before the word `How` is replaced with just one dot string.
+Note that the `:` and one space before the word `How` is replaced by one dot string.
 
-if the `--sep-string _` is used then the output will be
+If the `--sep-string _` is used then the above 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][] and
-  [Calibre CLI][] on your OS.
+- 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)
 
-  In particular the gem is looking for the `ebook-meta` binary in a path.
-  If this is not installed the error will be raised.
+Alternatively if Ubuntu Linux:
 
-* Linux or Mac OSX operating system
+```shell
+sudo apt-get install calibre calibre-bin
+# check your installation
+which ebook-meta #=> /usr/bin/ebook-meta
+```
+
+In particular the gem is looking for the `ebook-meta` binary in a path.
+If this is not installed the error will be raised.
+
+- Tested on Ruby 1.9.3 and newer
 
 ### Installation and Usage:
 
@@ -49,6 +57,30 @@ gem install ebook_renamer
 ebook_renamer
 ```
 
+### Usage/Synopsis
+
+```
+Usage:
+  ebook_renamer
+
+Options:
+  -b, [--base-dir=BASE_DIR]              # Base directory
+                                         # Default: . (current directory)
+  -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)
+  -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
+                                         # Default: --no-capitalize
+  -c, [--commit], [--no-commit]          # Make your changes permanent
+                                         # Default: --no-commit
+  -v, [--version], [--no-version]        # Display version information
+
+Rename multiple ebook files (pdf,epub,mobi) from a given directory
+```
+
 ### Quick Usage
 
 The shortest command that you can run to rename files is
@@ -60,7 +92,7 @@ cd ~/Dropbox/ebooks
 ebook_renamer --commit
 ```
 
-To see what the result would be like without making any changes
+To see what the result would be like without making any changes (dry-run)
 
 ```sh
 cd ~/Dropbox/ebooks/
@@ -90,7 +122,7 @@ cd ~/Dropbox/ebooks/
 ebook_renamer --base-dir . --sep-string _
 ```
 
-Should see the result like
+should result in something like
 
 ```
 -----------------------------------------------------------
@@ -119,9 +151,6 @@ cd ~/Dropbox/ebooks/
 # version of ruby (e.g. rbenv local 2.1.1 or rvm use 2.1.1)
 ebook_renamer --base-dir ~/Dropbox/ebooks/samples
 
-# 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) in the current directory
 ebook_renamer --base-dir . --recursive
 
@@ -133,6 +162,7 @@ ebook_renamer -b . -r -c
 ```
 
 ### Misc Options
+
 In addition to the above usage, you can also use the two new flags `--downcase` or
 `--capitalize`
 
@@ -144,31 +174,6 @@ ebook_renamer --base-dir . --recursive --downcase --commit
 ebook_renamer --base-dir . --recursive --capitalize --commit
 ```
 
-### Usage/Synopsis
-
-```
-Usage:
-  ebook_renamer
-
-Options:
-  -b, [--base-dir=BASE_DIR]              # Base directory
-                                         # Default: . (current directory)
-  -r, [--recursive], [--no-recursive]    # Search for files recursively
-                                         # Default: --recursive
-  -s, [--sep-string=SEP_STRING]          # Separator string between words in output filename
-                                         # Default: . (dot string)
-  -d, [--downcase], [--no-downcase]      # Convert each word in the filename to lowercase
-                                         # Default: --no-downcase
-  -t, [--capitalize], [--no-capitalize]  # Capitalize each word in the filename
-                                         # Default: --no-capitalize
-  -c, [--commit], [--no-commit]          # Make change permanent
-                                         # Default: --no-commit
-  -v, [--version], [--no-version]        # Display version information
-
-Rename multiple ebook files (pdf,epub,mobi) from a given directory
-
-```
-
 ### Contributing
 
 1. Fork it

data/Rakefile

@@ -1,14 +1,11 @@
 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
-
 task :pry do
   require "pry"
   require "awesome_print"

data/ebook_renamer.gemspec

@@ -24,18 +24,18 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
   spec.add_runtime_dependency "thor", "~> 0.19"
-  spec.add_runtime_dependency "agile_utils", "~> 0.1"
-  spec.add_runtime_dependency "code_lister", "~> 0.1"
-  spec.add_runtime_dependency "filename_cleaner", "~> 0.3.8"
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "awesome_print", "~> 1.2"
+  spec.add_runtime_dependency "agile_utils", "~> 0.2.0"
+  spec.add_runtime_dependency "code_lister", "~> 0.2.0"
+  spec.add_runtime_dependency "filename_cleaner", "~> 0.4.0"
+  spec.add_development_dependency "bundler", "~> 1.6.2"
+  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.2"
-  spec.add_development_dependency "minitest", "~> 5.3"
-  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"
-  spec.add_development_dependency "rubocop", "~> 0.20"
+  spec.add_development_dependency "guard-minitest", "~> 2.3.1"
+  spec.add_development_dependency "minitest", "~> 5.4.0"
+  spec.add_development_dependency "guard", "~> 2.6.1"
+  spec.add_development_dependency "pry", "~> 0.10.0"
+  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"
 end

data/lib/ebook_renamer/cli.rb

@@ -5,6 +5,8 @@ require "fileutils"
 require_relative "../ebook_renamer"
 module EbookRenamer
   class CLI < Thor
+    using AgileUtils::HashExt
+
     desc "rename", "Rename multiple ebook files (pdf,epub,mobi) from a given directory"
     method_option *AgileUtils::Options::BASE_DIR
     method_option *AgileUtils::Options::RECURSIVE
@@ -68,7 +70,7 @@ Rename multiple ebook files (pdf,epub,mobi) from a given directory
 
     default_task :usage
 
-  private
+    private
 
     # Rename the file from the given directory
     def execute(options = {})

data/lib/ebook_renamer/version.rb

@@ -1,3 +1,3 @@
 module EbookRenamer
-  VERSION = "0.1.12"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ebook_renamer
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.2.0
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -30,84 +30,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: code_lister
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: filename_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.8
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.6.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.3.2
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: minitest-spec-context
   requirement: !ruby/object:Gem::Requirement
@@ -128,98 +128,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 2.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 2.3.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: 5.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.3'
+        version: 5.4.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: 2.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: 2.6.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: gem-ctags
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.6
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: 0.24.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: 0.24.1
 description: Bulk rename of ebook files (pdf, epub, mobi) based on embedded metadata
 email:
 - agilecreativity@gmail.com