epuber 0.3.5

data/lib/epuber/compiler/file_types/abstract_file.rb

@@ -0,0 +1,119 @@
+# encoding: utf-8
+
+
+module Epuber
+  class Compiler
+    module FileTypes
+      class AbstractFile
+
+        # @return [String] relative destination path
+        #
+        attr_accessor :destination_path
+
+        # @return [Symbol] group of this file (:text, :image, :font, ...), see Epuber::Compiler::FileFinder::GROUP_EXTENSIONS
+        #
+        attr_accessor :group
+
+        # @return [Set<Symbol>] list of properties
+        #
+        attr_accessor :properties
+
+        # @return [Set<Symbol>] list of properties
+        #
+        def properties
+          @properties ||= Set.new
+        end
+
+
+        # @return [String] final relative destination path from root of the package calculated by FileResolver
+        #
+        attr_accessor :pkg_destination_path
+
+        # @return [String] final absolute destination path calculated by FileResolver
+        #
+        attr_accessor :final_destination_path
+
+        # @return [Symbol] type of path, one of :spine, :manifest, :package
+        #
+        attr_accessor :path_type
+
+
+        def ==(other)
+          self.class == other.class && final_destination_path == other.final_destination_path
+        end
+
+
+        ################################################################################################################
+
+        # @param [String] source_path
+        # @param [String] dest_path
+        #
+        # @return [Bool]
+        #
+        def self.file_copy?(source_path, dest_path)
+          return false if FileUtils.uptodate?(dest_path, [source_path])
+          return false if File.exists?(dest_path) && FileUtils.compare_file(dest_path, source_path)
+
+          true
+        end
+
+        # @param [String] source_path
+        # @param [String] dest_path
+        #
+        # @return nil
+        #
+        def self.file_copy(source_path, dest_path)
+          return unless file_copy?(source_path, dest_path)
+
+          file_copy!(source_path, dest_path)
+        end
+
+        # @param [String] source_path
+        # @param [String] dest_path
+        #
+        # @return nil
+        #
+        def self.file_copy!(source_path, dest_path)
+          FileUtils.mkdir_p(File.dirname(dest_path))
+
+          FileUtils.cp(source_path, dest_path)
+        end
+
+        # @param [String | #to_s] content anything, that can be converted to string and should be written to file
+        # @param [String] to_path  destination path
+        #
+        # @return nil
+        #
+        def self.write_to_file?(content, to_path)
+          return true unless File.exists?(to_path)
+
+          File.read(to_path) != content.to_s
+        end
+
+        # @param [String | #to_s] content anything, that can be converted to string and should be written to file
+        # @param [String] to_path  destination path
+        #
+        # @return nil
+        #
+        def self.write_to_file(content, to_path)
+          return unless write_to_file?(content, to_path)
+
+          write_to_file!(content, to_path)
+        end
+
+        # @param [String | #to_s] content anything, that can be converted to string and should be written to file
+        # @param [String] to_path  destination path
+        #
+        # @return nil
+        #
+        def self.write_to_file!(content, to_path)
+          FileUtils.mkdir_p(File.dirname(to_path))
+
+          File.open(to_path, 'w') do |file_handle|
+            file_handle.write(content)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/epuber/compiler/file_types/bade_file.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'bade'
+
+
+module Epuber
+  class Compiler
+    module FileTypes
+      require_relative 'xhtml_file'
+
+      class BadeFile < XHTMLFile
+        # @param [Epuber::Compiler::CompilationContext] compilation_context
+        #
+        def process(compilation_context)
+          target = compilation_context.target
+          book = compilation_context.book
+          file_resolver = compilation_context.file_resolver
+
+          bade_content = load_source(compilation_context)
+
+          variables = {
+            __book: book,
+            __target: target,
+            __file_resolver: file_resolver,
+            __file: self,
+            __toc_item: toc_item,
+            __const: Hash.new { |_hash, key| UI.warning("Undefined constant with key `#{key}`", location: caller_locations[0]) }.merge!(target.constants),
+          }
+
+          xhtml_content = Bade::Renderer.from_source(bade_content, source_path)
+                                        .with_locals(variables)
+                                        .render(new_line: '', indent: '')
+
+          write_compiled(common_process(xhtml_content, compilation_context))
+        end
+      end
+    end
+  end
+end

data/lib/epuber/compiler/file_types/container_xml_file.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+
+module Epuber
+  class Compiler
+    module FileTypes
+      require_relative 'generated_file'
+
+      class ContainerXMLFile < GeneratedFile
+        def initialize
+          super
+
+          self.destination_path = 'META-INF/container.xml'
+          self.path_type = :package
+        end
+
+        # @param [Compiler::CompilationContext] compilation_context
+        #
+        def process(compilation_context)
+          gen = MetaInfGenerator.new(compilation_context)
+          write_generate(gen.generate_container_xml)
+        end
+      end
+    end
+  end
+end

data/lib/epuber/compiler/file_types/generated_file.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+
+module Epuber
+  class Compiler
+    module FileTypes
+      require_relative 'abstract_file'
+
+      class GeneratedFile < AbstractFile
+        # @return [String | #to_s] files content
+        #
+        attr_accessor :content
+
+        # @param [Compiler::CompilationContext] compilation_context
+        #
+        def process(compilation_context)
+          write_generate(content.to_s)
+        end
+
+        def write_generate(content)
+          if self.class.write_to_file?(content, final_destination_path)
+            UI.print_processing_debug_info("Writing generated content to #{pkg_destination_path}")
+            self.class.write_to_file!(content, final_destination_path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/epuber/compiler/file_types/ibooks_display_options_file.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+
+module Epuber
+  class Compiler
+    module FileTypes
+      require_relative 'generated_file'
+
+      class IBooksDisplayOptionsFile < GeneratedFile
+        def initialize
+          super
+
+          self.destination_path = 'META-INF/com.apple.ibooks.display-options.xml'
+          self.path_type = :package
+        end
+
+        # @param [Compiler::CompilationContext] compilation_context
+        #
+        def process(compilation_context)
+          gen = MetaInfGenerator.new(compilation_context)
+          write_generate(gen.generate_ibooks_display_options_xml)
+        end
+      end
+    end
+  end
+end
+
+
+
+
+

data/lib/epuber/compiler/file_types/image_file.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rmagick'
+
+
+module Epuber
+  class Compiler
+    module FileTypes
+      require_relative 'source_file'
+
+      class ImageFile < SourceFile
+        # @param [Compiler::CompilationContext] compilation_context
+        #
+        def process(compilation_context)
+          dest = final_destination_path
+          source = abs_source_path
+
+          return if FileUtils.uptodate?(dest, [source])
+
+          img = Magick::Image::read(source).first
+
+          resolution = img.columns * img.rows
+          max_resolution = 3_000_000
+
+          if resolution > max_resolution
+            img = img.change_geometry("#{max_resolution}@>") do |width, height, b_img|
+              UI.print_processing_debug_info("downscaling from resolution #{b_img.columns}x#{b_img.rows} to #{width}x#{height}")
+              b_img.resize!(width, height)
+            end
+
+            FileUtils.mkdir_p(File.dirname(dest))
+
+            img.write(dest)
+          else
+            # file is already old
+            self.class.file_copy!(source, dest)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/epuber/compiler/file_types/mime_type_file.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+
+module Epuber
+  class Compiler
+    module FileTypes
+      require_relative 'generated_file'
+
+      class MimeTypeFile < GeneratedFile
+        def initialize
+          super
+
+          self.path_type        = :package
+          self.destination_path = 'mimetype'
+          self.content          = 'application/epub+zip'
+        end
+      end
+    end
+  end
+end

data/lib/epuber/compiler/file_types/nav_file.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+
+module Epuber
+  class Compiler
+    module FileTypes
+      require_relative 'generated_file'
+
+      class NavFile < GeneratedFile
+
+        # @return [Epuber::Version]
+        #
+        attr_reader :epub_version
+
+        # @param [Epuber::Version] epub_version
+        #
+        def initialize(epub_version)
+          super()
+
+          @epub_version = epub_version
+
+          properties << :navigation
+
+          self.destination_path = if epub_version >= 3
+                                    'nav.xhtml'
+                                  else
+                                    'nav.ncx'
+                                  end
+
+          self.path_type = :manifest
+        end
+
+        # @param [Compiler::CompilationContext] compilation_context
+        #
+        def process(compilation_context)
+          gen = NavGenerator.new(compilation_context)
+          write_generate(gen.generate_nav.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/epuber/compiler/file_types/opf_file.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+
+module Epuber
+  class Compiler
+    module FileTypes
+      require_relative 'generated_file'
+
+      class OPFFile < GeneratedFile
+
+        def initialize
+          super
+
+          self.destination_path = File.join(Epuber::Compiler::EPUB_CONTENT_FOLDER, 'content.opf')
+          self.path_type = :package
+        end
+
+        # @param [Compiler::CompilationContext] compilation_context
+        #
+        def process(compilation_context)
+          gen = OPFGenerator.new(compilation_context)
+          write_generate(gen.generate_opf.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/epuber/compiler/file_types/source_file.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+
+module Epuber
+  class Compiler
+    module FileTypes
+      require_relative 'abstract_file'
+
+      class SourceFile < AbstractFile
+
+        # @return [String] relative source path
+        #
+        attr_reader :source_path
+
+        # @return [String] absolute source path
+        #
+        attr_accessor :abs_source_path
+
+        # @return [Epuber::Book::FileRequest]
+        #
+        attr_accessor :file_request
+
+        # @param [String] source_path  relative path from project root to source file
+        #
+        def initialize(source_path)
+          @source_path = source_path
+        end
+
+        def default_file_copy
+          if self.class.file_copy?(abs_source_path, final_destination_path)
+            UI.print_processing_debug_info("Copying to #{pkg_destination_path}")
+            self.class.file_copy!(abs_source_path, final_destination_path)
+          end
+        end
+
+        def write_compiled(content)
+          if self.class.write_to_file?(content, final_destination_path)
+            UI.print_processing_debug_info("Writing compiled version to #{pkg_destination_path}")
+            self.class.write_to_file!(content, final_destination_path)
+          end
+        end
+
+        def write_processed(content)
+          if self.class.write_to_file?(content, final_destination_path)
+            UI.print_processing_debug_info("Writing processed version to #{pkg_destination_path}")
+            self.class.write_to_file!(content, final_destination_path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/epuber/compiler/file_types/static_file.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+
+module Epuber
+  class Compiler
+    module FileTypes
+      require_relative 'source_file'
+
+      class StaticFile < SourceFile
+        # @param [Compiler::CompilationContext] compilation_context
+        #
+        def process(compilation_context)
+          default_file_copy
+        end
+      end
+    end
+  end
+end