epuber 0.7.4 → 0.8.0

data/lib/epuber/command/init.rb

@@ -50,9 +50,9 @@ 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
@@ -76,16 +76,18 @@ END
       # @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 +97,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,15 +106,13 @@ 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
@@ -122,7 +122,7 @@ END
       #
       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
@@ -146,7 +146,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,7 +155,7 @@ 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]
@@ -167,7 +167,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,7 +13,7 @@ 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
 
@@ -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

@@ -21,21 +21,18 @@ module Epuber
     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 +67,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
@@ -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
@@ -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,15 +230,17 @@ 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
         #
@@ -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

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

@@ -11,6 +11,8 @@ module Epuber
           #
           attr_accessor :entries
 
+          # @return [String]
+          #
           attr_reader :name
 
           def initialize(name)
@@ -32,8 +34,12 @@ module Epuber
         end
 
         class FileEntry
+          # @return [String]
+          #
           attr_reader :name
 
+          # @return [String]
+          #
           attr_reader :absolute_path
 
           def initialize(name, absolute_path)
@@ -42,7 +48,7 @@ module Epuber
           end
 
           def ==(other)
-            other.is_a?(FileEntry) ? name == other.name : name == other.to_s
+            name == (other.is_a?(FileEntry) ? other.name : other.to_s)
           end
         end
 
@@ -83,14 +89,11 @@ module Epuber
           make_dir_p(path)[file_name] = FileEntry.new(file_name, file_path)
         end
 
-
         def __core_find_files_from_pattern(pattern)
           parts = self.class.path_parts(pattern)
           found_entries = find_recurser(root, parts).flatten
           file_entries = found_entries.reject { |entry| entry.is_a?(DirEntry) }
-          file_entries.map do |item|
-            item.absolute_path
-          end
+          file_entries.map(&:absolute_path)
         end
 
         def __core_file?(path)
@@ -104,12 +107,14 @@ module Epuber
           current.is_a?(FileEntry)
         end
 
-        private
-
-        def self.path_parts(path)
-          path.split(File::SEPARATOR).reject(&:empty?)
+        class << self
+          def path_parts(path)
+            path.split(File::SEPARATOR).reject(&:empty?)
+          end
         end
 
+        private
+
         def find_recurser(dir, parts)
           return [] unless dir.respond_to? :[]
 
@@ -117,25 +122,25 @@ module Epuber
           return [] if pattern.nil?
 
           matches         = case pattern
-                              when '**'
-                                case parts
-                                  when ['*']
-                                    parts = [] # end recursion
-                                    directories_under(dir).map do |d|
-                                      d.entries.select do |f|
-                                        (f.is_a?(FileEntry) || f.is_a?(DirEntry)) &&
-                                          f.name.match(/\A(?!\.)/)
-                                      end
-                                    end.flatten.uniq
-                                  when []
-                                    parts = [] # end recursion
-                                    dir.entries.values.flatten.uniq
-                                  else
-                                    directories_under(dir)
-                                end
+                            when '**'
+                              case parts
+                              when ['*']
+                                parts = [] # end recursion
+                                directories_under(dir).map do |d|
+                                  d.entries.select do |f|
+                                    (f.is_a?(FileEntry) || f.is_a?(DirEntry)) &&
+                                      f.name.match(/\A(?!\.)/)
+                                  end
+                                end.flatten.uniq
+                              when []
+                                parts = [] # end recursion
+                                dir.entries.values.flatten.uniq
                               else
-                                regex_body = pattern_to_regex(pattern)
-                                dir.entries.reject { |k, _v| /\A#{regex_body}\Z/ !~ k }.values
+                                directories_under(dir)
+                              end
+                            else
+                              regex_body = pattern_to_regex(pattern)
+                              dir.entries.select { |k, _v| /\A#{regex_body}\Z/ =~ k }.values
                             end
 
           if parts.empty? # we're done recursing
@@ -156,14 +161,14 @@ module Epuber
 
         def pattern_to_regex(pattern)
           pattern.gsub('.', '\.')
-            .gsub('?', '.')
-            .gsub('*', '.*')
-            .gsub('(', '\(')
-            .gsub(')', '\)')
-            .gsub(/\{(.*?)\}/) do
-              "(#{Regexp.last_match[1].gsub(',', '|')})"
-            end
-            .gsub(/\A\./, '(?!\.).')
+                 .gsub('?', '.')
+                 .gsub('*', '.*')
+                 .gsub('(', '\(')
+                 .gsub(')', '\)')
+                 .gsub(/\{(.*?)\}/) do
+                   "(#{Regexp.last_match[1].gsub(',', '|')})"
+                 end
+                 .gsub(/\A\./, '(?!\.).')
         end
       end
     end