epuber 0.3.12 → 0.4.0

data/lib/epuber/command/init.rb

@@ -36,12 +36,12 @@ module Epuber
         write_bookspec(@book_name)
         write_sublime_project(@book_name)
 
-        FileUtils.mkdir_p('images')
-        FileUtils.mkdir_p('fonts')
-        FileUtils.mkdir_p('styles')
+        create_folder('images')
+        create_folder('fonts')
+        create_folder('styles')
         write_default_style(@book_name)
 
-        FileUtils.mkdir_p('text')
+        create_folder('text')
 
         print_good_bye(@book_name)
       end
@@ -51,7 +51,7 @@ module Epuber
 
       def print_good_bye(book_id)
         puts <<-END.ansi.green
-Project initialized, please review #{book_id}.bookspec file, remove comments.
+Project initialized, please review #{book_id}.bookspec file, remove comments and fill some attributes like book title.
 END
       end
 
@@ -101,8 +101,10 @@ END
 *.epub
 *.mobi
 !.epuber/
-.epuber/build
-.epuber/release_build
+.epuber/build/
+.epuber/release_build/
+.epuber/build_cache/
+.epuber/metadata/
 
         END
         )
@@ -122,6 +124,16 @@ END
       #
       def write(file_path, string)
         File.write(file_path, string)
+        puts "   #{'create'.ansi.green}  #{file_path}"
+      end
+
+      # @param [String] dir_path path to dir
+      #
+      # @return [nil]
+      #
+      def create_folder(dir_path)
+        FileUtils.mkdir_p(dir_path)
+        puts "   #{'create'.ansi.green}  #{dir_path}/"
       end
 
       # @param text [String]

data/lib/epuber/command/server.rb

@@ -37,7 +37,7 @@ module Epuber
         require_relative '../server'
 
         target = if @selected_target_name.nil?
-                   book.targets.first
+                   book.all_targets.first
                  else
                    book.target_named(@selected_target_name)
                  end

data/lib/epuber/compiler.rb

@@ -24,6 +24,8 @@ module Epuber
     require_relative 'compiler/file_resolver'
     require_relative 'compiler/file_finders/normal'
 
+    require_relative 'compiler/file_database'
+
 
     EPUB_CONTENT_FOLDER = 'OEBPS'
 
@@ -59,13 +61,14 @@ module Epuber
     #
     # @return [void]
     #
-    def compile(build_folder, check: false, write: false, release: false, verbose: false)
+    def compile(build_folder, check: false, write: false, release: false, verbose: false, use_cache: true)
       @file_resolver = FileResolver.new(Config.instance.project_path, build_folder)
       compilation_context.file_resolver = @file_resolver
       compilation_context.should_check = check
       compilation_context.should_write = write
       compilation_context.release_build = release
       compilation_context.verbose = verbose
+      compilation_context.use_cache = use_cache
 
       self.class.globals_catcher.catch do
         @build_folder = build_folder
@@ -74,6 +77,9 @@ module Epuber
 
         puts "  handling target #{@target.name.inspect} in build dir `#{Config.instance.pretty_path_from_project(build_folder)}`"
 
+        file_resolver.add_file(FileTypes::SourceFile.new(Config.instance.pretty_path_from_project(@book.file_path).to_s))
+        compilation_context.plugins
+
         parse_toc_item(@target.root_toc)
         parse_target_file_requests
 
@@ -83,6 +89,15 @@ module Epuber
         # build folder cleanup
         remove_unnecessary_files
         remove_empty_folders
+
+        source_paths = file_resolver.files.select { |a| a.is_a?(FileTypes::SourceFile) }.map { |a| a.source_path }
+        compilation_context.source_file_database.cleanup(source_paths)
+        compilation_context.source_file_database.update_all_metadata
+        compilation_context.source_file_database.save_to_file
+
+        compilation_context.target_file_database.cleanup(source_paths)
+        compilation_context.target_file_database.update_all_metadata
+        compilation_context.target_file_database.save_to_file
       end
     ensure
       self.class.globals_catcher.clear_all
@@ -205,10 +220,49 @@ module Epuber
       end
     end
 
-    # @param [FileTypes::AbstractFile] file
+    # @param [Epuber::Compiler::FileTypes::AbstractFile] file
     #
     def process_file(file)
+      file.compilation_context = compilation_context
+
+      resolve_dependencies(file) if file.is_a?(FileTypes::SourceFile)
       file.process(compilation_context)
+
+      file.compilation_context = nil
+    end
+
+    # @param [FileTypes::SourceFile] file
+    #
+    def resolve_dependencies(file)
+      deps = file.find_dependencies
+
+      # compute better paths for FileDatabase
+      dirname = File.dirname(file.source_path)
+      paths = deps.map { |relative| Config.instance.pretty_path_from_project(File.expand_path(relative, dirname)) }.uniq
+
+      # add missing files to file_resolver
+      paths.each do |path|
+        next if file_resolver.file_with_source_path(path)
+        file_resolver.add_file(FileTypes::SourceFile.new(path))
+      end
+
+      # add .bookspec file
+      paths += [Config.instance.pretty_path_from_project(@book.file_path).to_s]
+
+      # add all activated plugin files
+      paths += compilation_context.plugins.map do |plugin|
+        plugin.files.map { |p_file| p_file.source_path }
+      end.flatten
+
+      # add dependencies to databases
+      source_db = compilation_context.source_file_database
+      source_db.update_metadata(file.source_path) unless source_db.file_stat_for(file.source_path)
+      source_db.add_dependency(paths, to: file.source_path)
+
+      # add dependencies to databases
+      target_db = compilation_context.target_file_database
+      target_db.update_metadata(file.source_path) unless target_db.file_stat_for(file.source_path)
+      target_db.add_dependency(paths, to: file.source_path)
     end
 
     # @return nil

data/lib/epuber/compiler/compilation_context.rb

@@ -16,12 +16,24 @@ module Epuber
       #
       attr_accessor :file_resolver
 
+      # This will track source files regardless of current target
+      #
+      # @return [Epuber::Compiler::FileDatabase]
+      #
+      attr_reader :source_file_database
+
+      # This will track source files depend on current target
+      #
+      # @return [Epuber::Compiler::FileDatabase]
+      #
+      attr_reader :target_file_database
+
       # @return [Array<Epuber::Plugin>]
       #
       def plugins
         @plugins ||= @target.plugins.map do |path|
           begin
-            plugin = Plugin.new(File.expand_path(path, Config.instance.project_path))
+            plugin = Plugin.new(path)
             plugin.files.each do |file|
               file_resolver.add_file(file)
             end
@@ -68,6 +80,10 @@ module Epuber
       #
       attr_accessor :release_build
 
+      # @return [Bool]
+      #
+      attr_accessor :use_cache
+
       # @return [Bool]
       #
       attr_accessor :verbose
@@ -76,10 +92,20 @@ module Epuber
         verbose
       end
 
+      def debug?
+        !release_build
+      end
+
+      def incremental_build?
+        use_cache
+      end
 
       def initialize(book, target)
         @book = book
         @target = target
+
+        @source_file_database = FileDatabase.new(Config.instance.file_stat_database_path)
+        @target_file_database = FileDatabase.new(Config.instance.target_file_stat_database_path(target))
       end
     end
   end

data/lib/epuber/compiler/file_database.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'yaml'
+
+
+module Epuber
+  class Compiler
+    require_relative 'file_stat'
+
+    class FileDatabase
+
+      # @return [Hash<String, Epuber::Compiler::FileStat>]
+      #
+      attr_accessor :all_files
+
+      # @return [String]
+      #
+      attr_reader :store_file_path
+
+      # @param [String] path
+      #
+      def initialize(path)
+        @store_file_path = path
+        @all_files = YAML.load_file(path) || {}
+      rescue
+        @all_files = {}
+      end
+
+      # @param [String] file_path
+      #
+      def changed?(file_path, transitive: true, default_value: true)
+        stat = @all_files[file_path]
+        return default_value if stat.nil?
+
+        result = (stat != FileStat.new(file_path))
+
+        if transitive
+          result ||= stat.dependency_paths.any? do |path|
+            changed?(path, transitive: transitive, default_value: false)
+          end
+        end
+
+        result
+      end
+
+      # @param [String] file_path
+      #
+      # @return [FileStat]
+      #
+      def file_stat_for(file_path)
+        @all_files[file_path]
+      end
+
+      # @param [String] file_path
+      #
+      def up_to_date?(file_path, transitive: true)
+        !changed?(file_path, transitive: transitive)
+      end
+
+      # @param [String] file_path
+      #
+      def update_metadata(file_path, load_stats: true)
+        old_stat = @all_files[file_path]
+        old_dependencies = old_stat ? old_stat.dependency_paths : []
+
+        @all_files[file_path] = FileStat.new(file_path, load_stats: load_stats, dependency_paths: old_dependencies)
+      end
+
+      def update_all_metadata
+        @all_files.each do |file_path, _|
+          update_metadata(file_path)
+        end
+      end
+
+      # @param [Array<String>, String] file_path  path to file that will be dependent on
+      # @param [String] to  path to original file, that will has new dependency
+      #
+      def add_dependency(file_path, to: nil)
+        raise ArgumentError, ':to is required' if to.nil?
+
+        file_paths = Array(file_path)
+
+        to_stat = @all_files[to]
+        raise ArgumentError, ":to (#{to}) file is not in database" if to_stat.nil?
+
+        to_stat.add_dependency!(file_paths)
+
+        begin
+          file_paths.each do |path|
+            update_metadata(path, load_stats: false) if @all_files[path].nil?
+          end
+        rescue Errno::ENOENT
+          # no action, valid case where dependant file does not exist
+        end
+      end
+
+      # @param [Array<String>] file_paths
+      #
+      def cleanup(file_paths)
+        to_remove = @all_files.keys - file_paths
+        to_remove.each { |key| @all_files.delete(key) }
+
+        @all_files.each do |_, stat|
+          _cleanup_stat_dependency_list(file_paths, stat)
+        end
+      end
+
+      # @param [String] path
+      #
+      def save_to_file(path = store_file_path)
+        FileUtils.mkdir_p(File.dirname(path))
+
+        File.write(path, @all_files.to_yaml)
+      end
+
+
+      # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+      private
+
+      # @param [Array<String>] file_paths
+      # @param [FileStat] stat
+      #
+      def _cleanup_stat_dependency_list(file_paths, stat)
+        stat.keep_dependencies!(file_paths)
+
+        stat.dependency_paths.each do |path|
+          next_stat = @all_files[path]
+          next if next_stat.nil?
+
+          _cleanup_stat_dependency_list(file_paths, next_stat)
+        end
+      end
+
+    end
+  end
+end

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

@@ -69,13 +69,15 @@ module Epuber
         image:  %w(.png .jpg .jpeg),
         font:   %w(.otf .ttf),
         style:  %w(.css .styl),
-        script: %w(.js),
+        script: %w(.js .coffee),
       }
 
       EXTENSIONS_RENAME = {
         '.styl' => '.css',
 
         '.bade' => '.xhtml',
+
+        '.coffee' => '.js',
       }
 
       class Abstract

data/lib/epuber/compiler/file_resolver.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require_relative '../ruby_extensions/string'
+require 'active_support/core_ext/object/try'
 
 module Epuber
   class Compiler
@@ -19,6 +20,7 @@ module Epuber
     require_relative 'file_types/mime_type_file'
     require_relative 'file_types/container_xml_file'
     require_relative 'file_types/ibooks_display_options_file'
+    require_relative 'file_types/coffee_script_file'
 
 
     class FileResolver
@@ -242,7 +244,7 @@ module Epuber
       #
       # @return [String] path with changed extension
       #
-      def renamed_file_with_path(path)
+      def self.renamed_file_with_path(path)
         extname     = File.extname(path)
         new_extname = FileFinders::EXTENSIONS_RENAME[extname]
 
@@ -261,7 +263,7 @@ module Epuber
         if file.final_destination_path.nil?
           dest_path = if file.respond_to?(:source_path) && !file.source_path.nil?
                         file.abs_source_path = File.expand_path(file.source_path, source_path)
-                        renamed_file_with_path(file.source_path)
+                        self.class.renamed_file_with_path(file.source_path)
                       elsif !file.destination_path.nil?
                         file.destination_path
                       else
@@ -282,6 +284,8 @@ module Epuber
         mapping = {
           '.styl'  => FileTypes::StylusFile,
 
+          '.coffee' => FileTypes::CoffeeScriptFile,
+
           '.bade'  => FileTypes::BadeFile,
           '.xhtml' => FileTypes::XHTMLFile,
           '.html'  => FileTypes::XHTMLFile,

data/lib/epuber/compiler/file_stat.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Epuber
+  class Compiler
+    class FileStat
+      # @return [Date]
+      #
+      attr_reader :mtime
+
+      # @return [Date]
+      #
+      attr_reader :ctime
+
+      # @return [Fixnum]
+      #
+      attr_reader :size
+
+      # @return [String]
+      #
+      attr_reader :file_path
+
+      # @return [String]
+      #
+      attr_reader :dependency_paths
+
+      # @param [String] path
+      # @param [File::Stat] stat
+      # @param [Bool] load_stats
+      #
+      def initialize(path, stat = nil, load_stats: true, dependency_paths: [])
+        @file_path = path
+
+        if load_stats
+          begin
+            stat ||= File.stat(path)
+            @mtime = stat.mtime
+            @ctime = stat.ctime
+            @size = stat.size
+          rescue
+            # noop
+          end
+        end
+
+        @dependency_paths = dependency_paths
+      end
+
+      # @param [Array<String>, String] path
+      #
+      def add_dependency!(path)
+        @dependency_paths += Array(path)
+        @dependency_paths.uniq!
+      end
+
+      # @param [Array<String>] paths
+      #
+      def keep_dependencies!(paths)
+        to_delete = (dependency_paths - paths)
+        @dependency_paths -= to_delete
+      end
+
+      # @param [FileStat] other
+      #
+      # @return [Bool]
+      #
+      def ==(other)
+        raise AttributeError, "other must be class of #{self.class}" unless other.is_a?(FileStat)
+
+        file_path == other.file_path &&
+             size == other.size &&
+            mtime == other.mtime &&
+            ctime == other.ctime
+      end
+    end
+  end
+end