ebooks_renamer 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8023c3193436aa238e7a4767ec89ba04ca62bc9
-  data.tar.gz: e8e0ffbdba67983f7e88827f4f02485031ecae32
+  metadata.gz: dcfe69c874481fe5d47d0b09b97899fb97bbe3a0
+  data.tar.gz: 104930f2174f8ae0c68be45e6afcb6cd57a182b0
 SHA512:
-  metadata.gz: ff7cb3e93207aaaedd3925dc95da8985d7acad85129f4ab03424ed2b2560becec4f03dbebf4269478d732bc62b86ebd8ef6539658207e085255b21a91d2a4476
-  data.tar.gz: efd7361232b1b888766efdd515968a123f31eccfe9005b49139650cbb1f3ed053c44aca7c7f0aef151183e01bb6a66584112b20e035e2a2244f32d28140d57cf
+  metadata.gz: 5b762829046bc8baca50428bb463a0e64c517f1ce33bfb006869a9516a27e3d6996724925fda2416a5e0bf8e655f0d8bf644d84274d01ad045bef15095eadac1
+  data.tar.gz: 3764692ae672455ff62d75cfab9f1404e8dab0a75d1f41665660be6a9acc7ec80cdadc07c42f56d5c4161214f1314cbec690075a26811fd0b4aaffa05fb058c5

data/.rubocop.yml

@@ -1,3 +1,95 @@
-# This is the configuration used to check the rubocop source code.
+AllCops:
+  Include:
+    - Gemfile
+    - Rakefile
+    - bin/*
+    - ebooks_cleaner.gemspec
+    - lib/**/*.rb
+    - test/**/*.rb
+# Avoid long parameter lists
+ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
 
-inherit_from: rubocop-todo.yml
+MethodLength:
+  CountComments: false
+  Max: 15
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 4
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    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
+
+# Limit line length
+LineLength:
+  Enabled: false
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Enforce Ruby 1.8-compatible hash syntax
+HashSyntax:
+  Enabled: true
+
+# No spaces inside hash literals
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# Allow dots at the end of lines
+DotPosition:
+  Enabled: false
+
+# Don't require magic comment at the top of every file
+Encoding:
+  Enabled: false
+
+# Enforce outdenting of access modifiers (i.e. public, private, protected)
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+# Align ends correctly
+EndAlignment:
+  AlignWith: variable
+
+# Indentation of when/else
+CaseIndentation:
+  IndentWhenRelativeTo: end
+  IndentOneStep: false
+
+DoubleNegation:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': '[]'
+    '%W': '[]'
+    '%x': ()
+
+StringLiterals:
+  EnforcedStyle: double_quotes

data/Gemfile

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

data/README.md

@@ -60,7 +60,7 @@ Or install it yourself as:
 
 ```
 Usage:
-  ebooks_renamer rename
+  ebooks_renamer
 
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory
@@ -90,11 +90,11 @@ rbenv local 2.1.2 # or any version after 1.9+
 gem install ebooks_renamer
 
 # run the command without making any changes
-ebooks_renamer rename --base-dir . --recursive
+ebooks_renamer --base-dir . --recursive
 
 # If you are happy with what will be changed then you can make your change permanent
 
-ebooks_renamer rename --base-dir . --recursive --commit
+ebooks_renamer --base-dir . --recursive --commit
 
 # To change the default separator string `sep_string` (default to '.' - dot string)
 # e.g. this will use the '_' (underscore) to separate each word in the output

data/Rakefile

@@ -1,6 +1,6 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-project_name = 'ebooks_renamer'
+require "bundler/gem_tasks"
+require "rake/testtask"
+project_name = "ebooks_renamer"
 
 Rake::TestTask.new do |t|
   t.libs << "lib/#{project_name}"
@@ -10,20 +10,20 @@ end
 
 task default: [:test, :rubocop]
 task :pry do
-  require 'pry'
-  require 'awesome_print'
-  require_relative 'lib/ebook_meta'
+  require "pry"
+  require "awesome_print"
+  require_relative "lib/ebook_meta"
   include EbooksRenamer
   ARGV.clear
   Pry.start
 end
 
-require 'rubocop/rake_task'
-desc 'Run RuboCop on the lib directory'
+require "rubocop/rake_task"
+desc "Run RuboCop on the lib directory"
 Rubocop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb']
+  task.patterns = ["lib/**/*.rb"]
   # only show the files with failures
-  task.formatters = ['files']
+  task.formatters = ["files"]
   # don't abort rake on failure
   task.fail_on_error = false
 end

data/bin/ebooks_renamer

@@ -1,4 +1,8 @@
 #!/usr/bin/env ruby
-require_relative '../lib/ebooks_renamer'
+require_relative "../lib/ebooks_renamer"
 include EbooksRenamer
-EbooksRenamer::CLI.start(ARGV)
+if ARGV.empty?
+  EbooksRenamer::CLI.start(%w[usage])
+else
+  EbooksRenamer::CLI.start(%w[rename].concat(ARGV))
+end

data/ebooks_renamer.gemspec

@@ -17,8 +17,7 @@ Gem::Specification.new do |spec|
                                                                  README.md
                                                                  LICENSE
                                                                  .rubocop.yml
-                                                                 .gitignore
-                                                                 rubocop-todo.yml)
+                                                                 .gitignore)
   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']

data/lib/ebooks_renamer.rb

@@ -1,7 +1,7 @@
-require_relative 'ebooks_renamer/version'
-require_relative 'ebooks_renamer/logger'
-require_relative 'ebooks_renamer/cli'
-require_relative 'ebooks_renamer/core_ext/hash/keys'
-require_relative 'ebooks_renamer/core_ext/object/blank'
-require_relative 'ebooks_renamer/ebooks_renamer'
+require_relative "ebooks_renamer/version"
+require_relative "ebooks_renamer/logger"
+require_relative "ebooks_renamer/cli"
+require_relative "ebooks_renamer/core_ext/hash/keys"
+require_relative "ebooks_renamer/core_ext/object/blank"
+require_relative "ebooks_renamer/ebooks_renamer"
 include EbooksRenamer

data/lib/ebooks_renamer/cli.rb

@@ -1,24 +1,21 @@
-require 'thor'
-require 'agile_utils'
-require_relative 'ebooks_renamer'
+require "thor"
+require "agile_utils"
+require_relative "ebooks_renamer"
 module EbooksRenamer
   class CLI < Thor
-    desc 'rename', 'Rename ebooks based on given criteria'
+    desc "rename", "Rename ebooks based on given criteria"
     method_option *AgileUtils::Options::BASE_DIR
     method_option *AgileUtils::Options::RECURSIVE
     method_option *AgileUtils::Options::VERSION
-
     method_option :sep_string,
-                  aliases: '-s',
-                  desc: 'Separator string between words in filename',
-                  default: '.'
-
+                  aliases: "-s",
+                  desc: "Separator string between words in filename",
+                  default: "."
     method_option :commit,
-                  aliases: '-c',
-                  desc: 'Make change permanent',
+                  aliases: "-c",
+                  desc: "Make change permanent",
                   type: :boolean,
                   default: false
-
     def rename
       opts = options.symbolize_keys
       if opts[:version]
@@ -26,17 +23,17 @@ module EbooksRenamer
         exit
       end
       # Add the default supported extensions
-      opts.merge!(exts: %w(pdf epub mobi))
+      opts.merge!(exts: %w[pdf epub mobi])
       puts "Your options #{opts}"
       EbooksRenamer.rename(opts)
     end
 
-    desc 'usage', 'Display help screen'
+    desc "usage", "Display help screen"
     def usage
       puts <<-EOS
 
 Usage:
-  ebooks_renamer rename
+  ebooks_renamer
 
 Options:
   -b, [--base-dir=BASE_DIR]                # Base directory

data/lib/ebooks_renamer/core_ext/hash/keys.rb

@@ -1,5 +1,4 @@
 class Hash
-
   # File activesupport/lib/active_support/core_ext/hash/keys.rb
   #
   # hash = { name: 'Rob', age: '28' }

data/lib/ebooks_renamer/ebooks_renamer.rb

@@ -1,13 +1,13 @@
-require 'mobi'
-require 'epubinfo'
-require 'pdf-reader'
-require 'ostruct'
-require 'fileutils'
-require 'filename_cleaner'
-require 'code_lister'
-require_relative 'pdf_parser'
-require_relative 'epub_parser'
-require_relative 'mobi_parser'
+require "mobi"
+require "epubinfo"
+require "pdf-reader"
+require "ostruct"
+require "fileutils"
+require "filename_cleaner"
+require "code_lister"
+require_relative "pdf_parser"
+require_relative "epub_parser"
+require_relative "mobi_parser"
 module EbooksRenamer
   CustomError = Class.new(StandardError)
   class << self
@@ -25,20 +25,20 @@ module EbooksRenamer
           else
             puts "#{index + 1} of #{files.length}: Result  : '#{old_name}' is identical so no action taken."
           end
-        rescue Exception => e
+        rescue => e
           puts "Skip file '#{file}'"
           puts "Due to the unexpected error: #{e.message}"
           next
         end
       end
       unless options[:commit]
-        puts '------------------------------------------------------------------'
-        puts 'This is a dry run only, to actually rename please specify --commit'
-        puts '------------------------------------------------------------------'
+        puts "------------------------------------------------------------------"
+        puts "This is a dry run only, to actually rename please specify --commit"
+        puts "------------------------------------------------------------------"
       end
     end
 
-    private
+  private
 
     def formatted_name(file, sep_string)
       meta = parse(file)
@@ -53,7 +53,7 @@ module EbooksRenamer
          File::SEPARATOR,
          FilenameCleaner.sanitize(name, sep_string, false),
          File.extname(file),
-        ].join('')
+        ].join("")
       else
         # return the full path of the original file
         File.expand_path(file)
@@ -73,11 +73,11 @@ module EbooksRenamer
 
     def parse(filename)
       case File.extname(filename)
-      when '.epub'
+      when ".epub"
         Parser.new(EpubParser.parse(filename)).parser
-      when '.pdf'
+      when ".pdf"
         Parser.new(PdfParser.parse(filename)).parser
-      when '.mobi'
+      when ".mobi"
         Parser.new(MobiParser.parse(filename)).parser
       else
         fail "File type #{File.extname(file)} is not supported"

data/lib/ebooks_renamer/logger.rb

@@ -1,4 +1,4 @@
-require 'logger'
+require "logger"
 module EbooksRenamer
   class << self
     attr_writer :logger

data/lib/ebooks_renamer/pdf_parser.rb

@@ -1,9 +1,9 @@
-require 'pry'
+require "pry"
 module EbooksRenamer
   class PdfParser
     class << self
       def parse(filename)
-        File.open(filename, 'rb') do |io|
+        File.open(filename, "rb") do |io|
           reader = PDF::Reader.new(io)
           if reader && reader.info && reader.info[:Title].present?
             OpenStruct.new title:  reader.info[:Title],
@@ -11,7 +11,7 @@ module EbooksRenamer
                            pages:  reader.page_count
           end
         end
-      rescue Exception => e
+      rescue => e
         # Note: we skip the file that we can't process
         # and allow the process to continue
         puts "Skip file '#{filename}'"

data/lib/ebooks_renamer/version.rb

@@ -1,3 +1,3 @@
 module EbooksRenamer
-  VERSION = '0.1.3'
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ebooks_renamer
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Burin Choomnuan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2014-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -275,7 +275,6 @@ files:
 - lib/ebooks_renamer/mobi_parser.rb
 - lib/ebooks_renamer/pdf_parser.rb
 - lib/ebooks_renamer/version.rb
-- rubocop-todo.yml
 homepage: https://github.com/agilecreativity/ebooks_renamer
 licenses:
 - MIT

data/rubocop-todo.yml

@@ -1,92 +0,0 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-04-23 16:41:01 +1000 using RuboCop version 0.19.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 2
-# Cop supports --auto-correct.
-DeprecatedClassMethods:
-  Enabled: false
-
-# Offense count: 9
-Documentation:
-  Enabled: false
-
-# Offense count: 6
-# Cop supports --auto-correct.
-EmptyLinesAroundBody:
-  Enabled: false
-
-# Offense count: 1
-Eval:
-  Enabled: false
-
-# Offense count: 2
-# Configuration parameters: Exclude.
-FileName:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-IndentationConsistency:
-  Enabled: true
-
-# Offense count: 2
-# Cop supports --auto-correct.
-LeadingCommentSpace:
-  Enabled: false
-
-# Offense count: 5
-LineLength:
-  Max: 89
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-MethodLength:
-  Max: 12
-
-# Offense count: 2
-# Configuration parameters: NamePrefixBlacklist.
-PredicateName:
-  Enabled: false
-
-# Offense count: 1
-RedundantBegin:
-  Enabled: true
-
-# Offense count: 1
-RescueException:
-  Enabled: false
-
-# Offense count: 2
-RescueModifier:
-  Enabled: false
-
-# Offense count: 2
-# Cop supports --auto-correct.
-SpaceAfterComma:
-  Enabled: true
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-SpaceBeforeBlockBraces:
-  Enabled: true
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
-SpaceInsideBlockBraces:
-  Enabled: true
-
-# Offense count: 16
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-StringLiterals:
-  Enabled: true
-
-# Offense count: 2
-UselessAssignment:
-  Enabled: true