epuber 0.7.4 → 0.9.0

data/lib/epuber/command/build.rb

@@ -4,6 +4,7 @@ require 'fileutils'
 require 'os'
 
 require_relative '../command'
+require_relative '../epubcheck'
 
 module Epuber
   class Command
@@ -25,7 +26,12 @@ module Epuber
         ].concat(super)
       end
 
-      # @param argv [CLAide::ARGV]
+      # To resolve problem with `compile` treating as subcommand
+      def self.subcommands
+        []
+      end
+
+      # @param [CLAide::ARGV] argv
       #
       def initialize(argv)
         @targets_names = argv.arguments!
@@ -50,48 +56,47 @@ module Epuber
       def run
         super
 
-        puts "compiling book `#{Config.instance.pretty_path_from_project(book.file_path)}`"
+        UI.puts "building book `#{Config.instance.pretty_path_from_project(book.file_path)}`"
 
         if @release_version
           # Remove all previous versions of compiled files
-          targets.each do |target|
-            build_path = Epuber::Config.instance.release_build_path(target)
-
-            if ::File.directory?(build_path)
-              FileUtils.remove_dir(build_path, true)
-            end
-          end
+          cleanup_build_folders
 
           # Build all targets to always clean directory
           targets.each do |target|
+            Epuber::Config.instance.release_build = true
+
             compiler = Epuber::Compiler.new(book, target)
             build_path = Epuber::Config.instance.release_build_path(target)
             compiler.compile(build_path, check: true, write: @should_write,
-                                       release: true, verbose: verbose?,
-                                     use_cache: false)
+                                         release: true, verbose: verbose?,
+                                         use_cache: false)
 
             archive_name = compiler.epub_name
 
-            if ::File.exist?(archive_name)
-              FileUtils.remove_file(archive_name)
-            end
+            FileUtils.remove_file(archive_name) if ::File.exist?(archive_name)
 
             archive_path = compiler.archive(archive_name)
 
-            system(%(epubcheck "#{archive_path}"))
+            Epubcheck.check(archive_path)
 
-            convert_epub_to_mobi(archive_path, ::File.basename(archive_path, '.epub') + '.mobi') if target.create_mobi
+            convert_epub_to_mobi(archive_path, "#{::File.basename(archive_path, '.epub')}.mobi") if target.create_mobi
+
+            Epuber::Config.instance.release_build = false
           end
+
+          # Build all targets to always clean directory
         else
           targets.each do |target|
             compiler = Epuber::Compiler.new(book, target)
             build_path = Epuber::Config.instance.build_path(target)
-            compiler.compile(build_path, check: @should_check, write: @should_write, verbose: verbose?, use_cache: @use_cache)
+            compiler.compile(build_path, check: @should_check, write: @should_write, verbose: verbose?,
+                                         use_cache: @use_cache)
             archive_path = compiler.archive(configuration_suffix: 'debug')
 
-            system(%(epubcheck "#{archive_path}")) if @should_check
+            Epubcheck.check(archive_path) if @should_check
 
-            convert_epub_to_mobi(archive_path, ::File.basename(archive_path, '.epub') + '.mobi') if target.create_mobi
+            convert_epub_to_mobi(archive_path, "#{::File.basename(archive_path, '.epub')}.mobi") if target.create_mobi
           end
         end
 
@@ -103,7 +108,7 @@ module Epuber
       # @return [Array<Epuber::Book::Target>]
       #
       def targets
-        @targets ||= (
+        @targets ||= begin
           targets = @targets_names
 
           # when the list of targets is nil pick all available targets
@@ -112,7 +117,7 @@ module Epuber
           else
             targets.map { |target_name| book.target_named(target_name) }
           end
-        )
+        end
       end
 
       def verify_all_targets_exists!
@@ -121,9 +126,9 @@ module Epuber
       end
 
       def validate_dir(path)
-        if ::File.directory?(path)
-          path
-        end
+        return unless ::File.directory?(path)
+
+        path
       end
 
       def find_calibre_app
@@ -141,7 +146,9 @@ module Epuber
           ::File.join(find_calibre_app, 'Contents/MacOS/ebook-convert')
         elsif OS.linux?
           script_path = '/usr/bin/ebook-convert'
-          UI.error!("Can't find ebook-convert in folder /usr/bin to convert EPUB to MOBI.") unless ::File.executable?(script_path)
+          unless ::File.executable?(script_path)
+            UI.error!("Can't find ebook-convert in folder /usr/bin to convert EPUB to MOBI.")
+          end
           script_path
         else
           UI.error!('Unsupported OS to convert EPUB to MOBI.')
@@ -151,6 +158,14 @@ module Epuber
       def convert_epub_to_mobi(epub_path, mobi_path)
         system(find_calibre_convert_file, epub_path, mobi_path)
       end
+
+      def cleanup_build_folders
+        targets.each do |target|
+          build_path = Epuber::Config.instance.release_build_path(target)
+
+          FileUtils.remove_dir(build_path, true) if ::File.directory?(build_path)
+        end
+      end
     end
   end
 end

data/lib/epuber/command/from_file.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require_relative '../from_file/from_file_executor'
+
+module Epuber
+  class Command
+    class FromFile < Command
+      self.summary = 'Initialize current folder to use it as Epuber project from existing EPUB file'
+      self.arguments = [
+        CLAide::Argument.new('EPUB_FILE', true),
+      ]
+
+      # @param [CLAide::ARGV] argv
+      #
+      def initialize(argv)
+        @filepath = argv.arguments!.first
+
+        super(argv)
+      end
+
+      def validate!
+        super
+
+        help! 'You must specify path to existing EPUB file' if @filepath.nil?
+        help! "File #{@filepath} doesn't exists" unless File.exist?(@filepath)
+
+        existing = Dir.glob('*.bookspec')
+        help! "Can't reinit this folder, #{existing.first} already exists." unless existing.empty?
+      end
+
+      def run
+        super
+
+        FromFileExecutor.new(@filepath).run
+      end
+    end
+  end
+end

data/lib/epuber/command/init.rb

@@ -11,10 +11,10 @@ module Epuber
     class Init < Command
       self.summary = 'Initialize current folder to use it as Epuber project'
       self.arguments = [
-        CLAide::Argument.new('PROJECT_NAME', false, true),
+        CLAide::Argument.new('PROJECT_NAME', false),
       ]
 
-      # @param argv [CLAide::ARGV]
+      # @param [CLAide::ARGV] argv
       #
       def initialize(argv)
         @book_name = argv.arguments!.first
@@ -23,6 +23,8 @@ module Epuber
       end
 
       def validate!
+        super
+
         help! 'You must specify identifier-like name of the book as first argument' if @book_name.nil?
 
         existing = Dir.glob('*.bookspec')
@@ -50,14 +52,14 @@ module Epuber
       private
 
       def print_good_bye(book_id)
-        puts <<-END.ansi.green
-Project initialized, please review #{book_id}.bookspec file, remove comments and fill some attributes like book title.
-END
+        UI.puts <<~TEXT.ansi.green
+          Project initialized, please review #{book_id}.bookspec file, remove comments and fill some attributes like book title.
+        TEXT
       end
 
       # Creates <book-id>.bookspec file from template
       #
-      # @param book_id [String]
+      # @param [String] book_id
       #
       # @return [void]
       #
@@ -71,21 +73,23 @@ END
 
       # Creates <book-id>.sublime-project
       #
-      # @param book_id [String]
+      # @param [String] book_id
       #
       # @return [void]
       #
       def write_sublime_project(book_id)
-        text = '{
-  "folders": [
-    {
-      "follow_symlinks": true,
-      "path": ".",
-      "folder_exclude_patterns": [".epuber"],
-      "file_exclude_patterns": ["*.epub"]
-    }
-  ]
-}'
+        text = <<~JSON
+          {
+            "folders": [
+              {
+                "follow_symlinks": true,
+                "path": ".",
+                "folder_exclude_patterns": [".epuber"],
+                "file_exclude_patterns": ["*.epub"]
+              }
+            ]
+          }
+        JSON
 
         write("#{book_id}.sublime-project", text)
       end
@@ -95,7 +99,7 @@ END
       # @return [void]
       #
       def write_gitignore
-        append_new_lines('.gitignore', <<~END
+        append_new_lines('.gitignore', <<~TEXT)
           # This is generated with `epuber init`
           *.epub
           *.mobi
@@ -104,29 +108,27 @@ END
           .epuber/release_build/
           .epuber/build_cache/
           .epuber/metadata/
-        END
-        )
+        TEXT
       end
 
       def write_default_style(book_id)
-        write("styles/#{book_id}.styl", <<~END
+        write("styles/#{book_id}.styl", <<~STYLUS)
           // This is generated with `epuber init` script.
-        END
-        )
+        STYLUS
       end
 
-      # @param string [String] text to file
-      # @param file_path [String] path to file
+      # @param [String] string text to file
+      # @param [String] file_path path to file
       #
       # @return [void]
       #
       def write(file_path, string)
         File.write(file_path, string)
-        puts "   #{'create'.ansi.green}  #{file_path}"
+        UI.puts "   #{'create'.ansi.green}  #{file_path}"
       end
 
-      # @param string [String] text to file
-      # @param file_path [String] path to file
+      # @param [String] string text to file
+      # @param [String] file_path path to file
       #
       # @return [void]
       #
@@ -146,7 +148,7 @@ END
         existing_content << "\n"
 
         File.write(file_path, existing_content)
-        puts "   #{'update'.ansi.green}  #{file_path}"
+        UI.puts "   #{'update'.ansi.green}  #{file_path}"
       end
 
       # @param [String] dir_path path to dir
@@ -155,10 +157,10 @@ END
       #
       def create_folder(dir_path)
         FileUtils.mkdir_p(dir_path)
-        puts "   #{'create'.ansi.green}  #{dir_path}/"
+        UI.puts "   #{'create'.ansi.green}  #{dir_path}/"
       end
 
-      # @param text [String]
+      # @param [String] text
       #
       # @return [String] returned text without new line
       #
@@ -167,7 +169,7 @@ END
         result = $stdin.gets.chomp
 
         while result.empty?
-          puts 'Value cannot be empty, please fill it!'.ansi.red
+          UI.puts 'Value cannot be empty, please fill it!'.ansi.red
           print text
           result = $stdin.gets.chomp
         end

data/lib/epuber/command/server.rb

@@ -13,11 +13,11 @@ module Epuber
 
       def self.options
         [
-          ['--open',   'Opens the web page in default web browser, working only on OS X'],
+          ['--open', 'Opens the web page in default web browser, working only on OS X'],
         ].concat(super)
       end
 
-      # @param args [CLAide::ARGV]
+      # @param [CLAide::ARGV] args
       #
       def initialize(args)
         super
@@ -51,7 +51,7 @@ module Epuber
               if @open_web_browser
                 system "open #{uri}"
               else
-                puts 'Web browser can be automatically opened by adding --open flag, see --help'
+                UI.puts 'Web browser can be automatically opened by adding --open flag, see --help'
               end
             end
           end

data/lib/epuber/command.rb

@@ -16,26 +16,24 @@ module Epuber
     require_relative 'command/compile'
     require_relative 'command/init'
     require_relative 'command/server'
+    require_relative 'command/from_file'
 
     self.abstract_command = true
     self.command = 'epuber'
     self.version = VERSION
     self.description = 'Epuber, easy creating and maintaining e-book.'
-    self.plugin_prefixes = plugin_prefixes + %w(epuber)
+    self.plugin_prefixes = plugin_prefixes + %w[epuber]
 
     def self.run(argv = [])
-      begin
-        UI.current_command = self
-        super
-        UI.current_command = nil
-
-      rescue Interrupt
-        UI.error('[!] Cancelled')
-      rescue => e
-        UI.error!(e)
-
-        UI.current_command = nil
-      end
+      UI.current_command = self
+      super
+      UI.current_command = nil
+    rescue Interrupt
+      UI.error('[!] Cancelled')
+    rescue StandardError => e
+      UI.error!(e)
+
+      UI.current_command = nil
     end
 
     def validate!
@@ -70,18 +68,18 @@ module Epuber
     end
 
     def write_lockfile
-      unless Epuber::Config.test?
-        Epuber::Config.instance.save_lockfile
-      end
+      return if Epuber::Config.test?
+
+      Epuber::Config.instance.save_lockfile
     end
 
     def pre_build_checks
       Config.instance.warn_for_outdated_versions!
 
-      if !Config.instance.same_version_as_last_run? && File.exist?(Config.instance.working_path)
-        UI.warning('Using different version of Epuber or Bade, removing all build caches')
-        Config.instance.remove_build_caches
-      end
+      return unless !Config.instance.same_version_as_last_run? && File.exist?(Config.instance.working_path)
+
+      UI.warning('Using different version of Epuber or Bade, removing all build caches')
+      Config.instance.remove_build_caches
     end
   end
 end

data/lib/epuber/compiler/compilation_context.rb

@@ -32,15 +32,13 @@ module Epuber
       #
       def plugins
         @plugins ||= @target.plugins.map do |path|
-          begin
-            plugin = Plugin.new(path)
-            plugin.files.each do |file|
-              file_resolver.add_file(file)
-            end
-            plugin
-          rescue LoadError
-            UI.error "Can't find plugin at path #{path}"
+          plugin = Plugin.new(path)
+          plugin.files.each do |file|
+            file_resolver.add_file(file)
           end
+          plugin
+        rescue LoadError
+          UI.error "Can't find plugin at path #{path}"
         end.compact
       end
 
@@ -100,6 +98,10 @@ module Epuber
         use_cache
       end
 
+      def release_build?
+        release_build
+      end
+
       def initialize(book, target)
         @book = book
         @target = target

data/lib/epuber/compiler/file_database.rb

@@ -7,7 +7,6 @@ module Epuber
     require_relative 'file_stat'
 
     class FileDatabase
-
       # @return [Hash<String, Epuber::Compiler::FileStat>]
       #
       attr_accessor :all_files
@@ -66,7 +65,7 @@ module Epuber
       end
 
       def update_all_metadata
-        @all_files.each do |file_path, _|
+        @all_files.each_key do |file_path|
           update_metadata(file_path)
         end
       end
@@ -99,7 +98,7 @@ module Epuber
         to_remove = @all_files.keys - file_paths
         to_remove.each { |key| @all_files.delete(key) }
 
-        @all_files.each do |_, stat|
+        @all_files.each_value do |stat|
           _cleanup_stat_dependency_list(file_paths, stat)
         end
       end
@@ -130,7 +129,6 @@ module Epuber
           _cleanup_stat_dependency_list(file_paths, next_stat)
         end
       end
-
     end
   end
 end

data/lib/epuber/compiler/file_finders/abstract.rb

@@ -16,6 +16,8 @@ module Epuber
         # @param [String] context_path
         #
         def initialize(pattern, context_path)
+          super()
+
           @pattern = pattern
           @context_path = context_path
         end
@@ -48,6 +50,8 @@ module Epuber
         # @param [Array<String>] files_paths  list of founded files
         #
         def initialize(pattern, groups, context_path, files_paths)
+          super()
+
           @pattern = pattern
           @groups = Array(groups)
           @context_path = context_path
@@ -61,16 +65,16 @@ module Epuber
         end
       end
 
-      BINARY_EXTENSIONS = %w(.png .jpeg .jpg .otf .ttf)
-      STATIC_EXTENSIONS = BINARY_EXTENSIONS + %w(.css .js)
+      BINARY_EXTENSIONS = %w[.png .jpeg .jpg .otf .ttf].freeze
+      STATIC_EXTENSIONS = BINARY_EXTENSIONS + %w[.css .js]
 
       GROUP_EXTENSIONS = {
-        text:   %w(.xhtml .html .bade),
-        image:  %w(.png .jpg .jpeg),
-        font:   %w(.otf .ttf),
-        style:  %w(.css .styl),
-        script: %w(.js .coffee),
-      }
+        text: %w[.xhtml .html .bade],
+        image: %w[.png .jpg .jpeg],
+        font: %w[.otf .ttf],
+        style: %w[.css .styl],
+        script: %w[.js .coffee],
+      }.freeze
 
       EXTENSIONS_RENAME = {
         '.styl' => '.css',
@@ -78,10 +82,9 @@ module Epuber
         '.bade' => '.xhtml',
 
         '.coffee' => '.js',
-      }
+      }.freeze
 
       class Abstract
-
         # @return [String] path where should look for source files
         #
         attr_reader :source_path
@@ -99,7 +102,6 @@ module Epuber
           @ignored_patterns = []
         end
 
-
         # @param [Array<Symbol> | Symbol] groups
         #
         def assert_one_file(files, pattern: nil, groups: nil, context_path: nil)
@@ -113,7 +115,8 @@ module Epuber
         # When it founds too many (more than two) it will raise MultipleFilesFoundError
         #
         # @param [String] pattern  pattern of the desired files
-        # @param [Array<Symbol> | Symbol] groups  list of group names, nil or empty array for all groups, for valid values see GROUP_EXTENSIONS
+        # @param [Array<Symbol> | Symbol] groups  list of group names, nil or empty array for all groups, for valid
+        #                                         values see GROUP_EXTENSIONS
         # @param [String] context_path  path for root of searching, it is also defines start folder of relative path
         #
         # @return [Array<String>] list of founded files
@@ -128,7 +131,8 @@ module Epuber
         # #source_path and after that it tries to search recursively from #source_path.
         #
         # @param [String] pattern  pattern of the desired files
-        # @param [Array<Symbol>] groups  list of group names, nil or empty array for all groups, for valid values see GROUP_EXTENSIONS
+        # @param [Array<Symbol>] groups  list of group names, nil or empty array for all groups, for valid values see
+        #                                GROUP_EXTENSIONS
         # @param [String] context_path  path for root of searching, it is also defines start folder of relative path
         #
         # @return [Array<String>] list of founded files
@@ -141,7 +145,9 @@ module Epuber
             searching_path = ::File.expand_path(context_path, @source_path_abs)
 
             unless searching_path.start_with?(@source_path_abs)
-              raise "You can't search from folder (#{searching_path}) that is not sub folder of the source_path (#{source_path}) expanded to (#{@source_path_abs})."
+              raise <<~ERROR
+                You can't search from folder (#{searching_path}) that is not sub folder of the source_path (#{source_path}) expanded to (#{@source_path_abs}).
+              ERROR
             end
 
             files = __find_files(pattern, groups, searching_path)
@@ -152,7 +158,7 @@ module Epuber
           end
 
           if files.empty? && search_everywhere && !pattern.start_with?('**')
-            files = __find_files('**/' + pattern, groups, @source_path_abs, searching_path || @source_path_abs)
+            files = __find_files("**/#{pattern}", groups, @source_path_abs, searching_path || @source_path_abs)
           end
 
           files
@@ -161,13 +167,14 @@ module Epuber
         # Looks for all files from #source_path recursively
         #
         # @param [String] pattern  pattern of the desired files
-        # @param [Array<Symbol>] groups  list of group names, nil or empty array for all groups, for valid values see GROUP_EXTENSIONS
+        # @param [Array<Symbol>] groups  list of group names, nil or empty array for all groups, for valid values see
+        #                                GROUP_EXTENSIONS
         # @param [String] context_path  path for root of searching, it is also defines start folder of relative path
         #
         # @return [Array<String>] list of founded files
         #
         def find_all(pattern, groups: nil, context_path: @source_path_abs)
-          __find_files('**/' + pattern, groups, context_path)
+          __find_files("**/#{pattern}", groups, context_path)
         end
 
         # @param [Array<String>] paths  list of file paths
@@ -187,7 +194,7 @@ module Epuber
             end.flatten
 
             paths.select do |file_path|
-              valid_extensions.include?(::File.extname(file_path))
+              valid_extensions.include?(::File.extname(file_path).downcase)
             end
           end
         end
@@ -209,7 +216,8 @@ module Epuber
         # Looks for files at given context path, if there is no file, it will try again with pattern for any extension
         #
         # @param [String] pattern  pattern of the desired files
-        # @param [Array<Symbol>] groups  list of group names, nil or empty array for all groups, for valid values see GROUP_EXTENSIONS
+        # @param [Array<Symbol>] groups  list of group names, nil or empty array for all groups, for valid values see
+        #                                GROUP_EXTENSIONS
         # @param [String] context_path  path for root of searching, it is also defines start folder of relative path
         # @param [String] orig_context_path  original context path, wo it will work nicely with iterative searching
         #
@@ -222,23 +230,25 @@ module Epuber
           files = __core_find_files(pattern, groups, context_path, orig_context_path)
 
           # try to find files with any extension
-          files = __core_find_files(pattern + '.*', groups, context_path, orig_context_path) if files.empty?
+          files = __core_find_files("#{pattern}.*", groups, context_path, orig_context_path) if files.empty?
 
           files
         end
 
-        # Core method for finding files, it only search for files, filter by input groups and map the final paths to pretty relative paths from context_path
+        # Core method for finding files, it only search for files, filter by input groups and map the final paths to
+        # pretty relative paths from context_path
         #
         # @param [String] pattern  pattern of the desired files
-        # @param [Array<Symbol>] groups  list of group names, nil or empty array for all groups, for valid values see GROUP_EXTENSIONS
+        # @param [Array<Symbol>] groups  list of group names, nil or empty array for all groups, for valid values see
+        #                                GROUP_EXTENSIONS
         # @param [String] context_path  path for root of searching, it is also defines start folder of relative path
         # @param [String] orig_context_path  original context path, wo it will work nicely with iterative searching
         #
         # @return [Array<String>] list of founded files
         #
         def __core_find_files(pattern, groups, context_path, orig_context_path = context_path)
-          context_path = __core_file?(context_path) ? File.dirname(context_path) : context_path
-          orig_context_path = __core_file?(orig_context_path) ? File.dirname(orig_context_path) : orig_context_path
+          context_path = File.dirname(context_path) if __core_file?(context_path)
+          orig_context_path = File.dirname(orig_context_path) if __core_file?(orig_context_path)
 
           full_pattern = File.expand_path(pattern, context_path)
           file_paths = __core_find_files_from_pattern(full_pattern).map(&:unicode_normalize)
@@ -258,11 +268,11 @@ module Epuber
           self.class.relative_paths_from(file_paths, orig_context_path)
         end
 
-        def __core_find_files_from_pattern(pattern)
+        def __core_find_files_from_pattern(_pattern)
           raise 'Implement this in subclass'
         end
 
-        def __core_file?(path)
+        def __core_file?(_path)
           raise 'Implement this in subclass'
         end
       end