epuber 0.3.12 → 0.4.0

data/lib/epuber/compiler/opf_generator.rb

@@ -59,6 +59,7 @@ module Epuber
         navigation:  'nav',
         scripted:    'scripted',
         remote_resources: 'remote-resources',
+        mathml: 'mathml',
       }.freeze
 
       OPF_UNIQUE_ID = 'bookid'

data/lib/epuber/compiler/xhtml_processor.rb

@@ -26,23 +26,41 @@ module Epuber
           text = text.lstrip
         end
 
-        doc = Nokogiri::XML(text)
+        xml_header = ''
+        if /\A\s*(<\?xml[^>]*\?>)/ =~ text
+          match = Regexp.last_match
+          xml_header = text[match.begin(1)...match.end(1)]
+          text[match.begin(1)...match.end(1)] = ''
+        end
+
+        doctypes = []
+        while /(\n|\?>|\A)?(<![^>]*>\n*)/ =~ text
+          doctypes << $2.strip
+
+          match = Regexp.last_match
+          text[match.begin(2)...match.end(2)] = ''
+        end
+
+        before = ([xml_header] + doctypes).compact.join("\n")
+        unless before.empty?
+          before = before + "\n"
+        end
+
+        parse_options = Nokogiri::XML::ParseOptions::DEFAULT_XML |
+                        Nokogiri::XML::ParseOptions::NOERROR | # to silence any errors or warnings printing into console
+                        Nokogiri::XML::ParseOptions::NOWARNING
+
+        doc = Nokogiri::XML("#{before}<root>#{text}</root>", nil, nil, parse_options)
         doc.encoding = 'UTF-8'
         doc.file_path = file_path
 
-        fragment = Nokogiri::XML.fragment(text)
-        root_elements = fragment.children.select { |el| el.element? }
+        root = root_node = doc.root
+        root_elements = root.children.select { |a| a.element? || a.comment? }
 
         if root_elements.count == 1
           doc.root = root_elements.first
-        elsif fragment.at_css('body').nil?
-          doc.root = doc.create_element('body')
-
-          fragment.children.select do |child|
-            child.element? || child.comment? || child.text?
-          end.each do |child|
-            doc.root.add_child(child)
-          end
+        elsif root_node.at_css('body').nil?
+          root_node.node_name = 'body'
         end
 
         doc
@@ -105,6 +123,24 @@ module Epuber
         end
       end
 
+      # Method for adding scripts with links, method will not add duplicate items
+      #
+      # @param [Nokogiri::XML::Document] xhtml_doc  input XML document to work with
+      # @param [Array<String>] styles  links to files
+      #
+      # @return nil
+      #
+      def self.add_scripts(xhtml_doc, scripts)
+        head  = xhtml_doc.at_css('html > head')
+        old_links = head.css('script').map { |node| node['src'] }
+
+        links_to_add = scripts - old_links
+
+        links_to_add.each do |path|
+          head << xhtml_doc.create_element('script', src: path, type: 'text/javascript')
+        end
+      end
+
       # Adds viewport meta tag to head of some document, but only if there is not some existing tag
       #
       # @param [Nokogiri::XML::Document] xhtml_doc
@@ -222,6 +258,20 @@ module Epuber
         result
       end
 
+      # @param [Nokogiri::XML::Document] xhtml_doc  input XML document to work with
+      #
+      # @return [Bool]
+      #
+      def self.using_mathml?(xhtml_doc)
+        !xhtml_doc.at_css('math|math', 'math' => 'http://www.w3.org/1998/Math/MathML').nil?
+      end
+
+      def self.resolve_mathml_namespace(xhtml_doc)
+        xhtml_doc.css('math').each do |math_node|
+          math_node.add_namespace('xmlns', 'http://www.w3.org/1998/Math/MathML')
+        end
+      end
+
       # @param [Nokogiri::XML::Document] xhtml_doc
       # @param [String] file_path path of referring file
       # @param [FileResolver] file_resolver
@@ -229,25 +279,52 @@ module Epuber
       # @return nil
       #
       def self.resolve_images(xhtml_doc, file_path, file_resolver)
+        resolve_resources_in('img', 'src', :image, xhtml_doc, file_path, file_resolver)
+      end
+
+      # @param [Nokogiri::XML::Document] xhtml_doc
+      # @param [String] file_path path of referring file
+      # @param [FileResolver] file_resolver
+      #
+      # @return nil
+      #
+      def self.resolve_scripts(xhtml_doc, file_path, file_resolver)
+        resolve_resources_in('script', 'src', :script, xhtml_doc, file_path, file_resolver)
+      end
+
+      # @param [Nokogiri::XML::Document] xhtml_doc
+      # @param [String] file_path path of referring file
+      # @param [FileResolver] file_resolver
+      #
+      # @return nil
+      #
+      def self.resolve_stylesheets(xhtml_doc, file_path, file_resolver)
+        resolve_resources_in('link[rel="stylesheet"]', 'href', :style, xhtml_doc, file_path, file_resolver)
+      end
+
+      def self.resolve_resources_in(node_css_query, attribute_name, resource_group, xhtml_doc, file_path, file_resolver)
         dirname = File.dirname(file_path)
 
-        xhtml_doc.css('img').each do |img|
-          path = img['src']
+        xhtml_doc.css(node_css_query).each do |img|
+          path = img[attribute_name]
           next if path.nil?
 
           begin
-            new_path = file_resolver.dest_finder.find_file(path, groups: :image, context_path: dirname)
+            new_path = file_resolver.dest_finder.find_file(path, groups: resource_group, context_path: dirname)
 
           rescue UnparseableLinkError, FileFinders::FileNotFoundError, FileFinders::MultipleFilesFoundError
             begin
-              new_path = resolved_link_to_file(path, :image, dirname, file_resolver.source_finder).to_s
+              new_path = resolved_link_to_file(path, resource_group, dirname, file_resolver.source_finder).to_s
               pkg_abs_path = File.expand_path(new_path, dirname).unicode_normalize
               pkg_new_path = Pathname.new(pkg_abs_path).relative_path_from(Pathname.new(file_resolver.source_path)).to_s
 
-              file = FileTypes::ImageFile.new(pkg_new_path)
+              file_class = FileResolver.file_class_for(File.extname(new_path))
+              file = file_class.new(pkg_new_path)
               file.path_type = :manifest
               file_resolver.add_file(file)
 
+              new_path = FileResolver::renamed_file_with_path(new_path)
+
             rescue UnparseableLinkError, FileFinders::FileNotFoundError, FileFinders::MultipleFilesFoundError => e
               UI.warning(e.to_s, location: img)
 
@@ -255,7 +332,7 @@ module Epuber
             end
           end
 
-          img['src'] = new_path
+          img[attribute_name] = new_path
         end
       end
     end

data/lib/epuber/config.rb

@@ -19,7 +19,7 @@ module Epuber
     # @return [String] relative path to file from root of project
     #
     def pretty_path_from_project(of_file)
-      Pathname.new(of_file.unicode_normalize).relative_path_from(Pathname.new(project_path))
+      Pathname.new(of_file.unicode_normalize).relative_path_from(Pathname.new(project_path)).to_s
     end
 
     # @return [String]
@@ -53,14 +53,7 @@ module Epuber
     # @return [Epuber::Book]
     #
     def bookspec
-      require_relative 'book'
-      @bookspec ||= (
-        book = Epuber::Book.from_file(bookspec_path)
-        book.finish_toc
-        book.validate
-        book.freeze
-        book
-      )
+      @bookspec ||= self.class.load_bookspec(bookspec_path)
     end
 
     # @param [Epuber::Book] bookspec
@@ -103,22 +96,62 @@ module Epuber
       File.join(working_path, 'release_build', target.name.to_s)
     end
 
-    # ---------------------------------------------------------------------------------------------------------------- #
+    # @param [String] cache_name
+    #
+    # @return [String]
+    #
+    def build_cache_path(cache_name)
+      File.join(working_path, 'build_cache', cache_name)
+    end
 
-    # Singleton
+    # @return [String]
     #
-    # @return [Epuber::Config]
+    def file_stat_database_path
+      File.join(working_path, 'metadata', 'source_file_stats.yml')
+    end
+
+    # @param [Epuber::Book::Target] target
+    #
+    # @return [String]
     #
-    def self.instance
-      @instance ||= new
+    def target_file_stat_database_path(target)
+      File.join(working_path, 'metadata', 'target_stats', target.name.to_s, 'file_stats.yml')
     end
 
+    # ---------------------------------------------------------------------------------------------------------------- #
+
     class << self
       attr_accessor :test
 
       def test?
         test
       end
+
+      # Singleton
+      #
+      # @return [Epuber::Config]
+      #
+      def instance
+        @instance ||= new
+      end
+
+      def clear_instance!
+        @instance = nil
+      end
+
+      # @return [Epuber::Book]
+      #
+      def load_bookspec(path, frozen: true)
+        require_relative 'book'
+
+        book = Epuber::Book.from_file(path)
+        book.finish_toc
+        book.validate
+
+        book.freeze if frozen
+
+        book
+      end
     end
 
     self.test = false

data/lib/epuber/plugin.rb

@@ -75,11 +75,16 @@ module Epuber
                  [PluginFile.new(path)]
                elsif ::File.directory?(path)
                  Dir.glob(File.expand_path('**/*.rb', path)).map do |file_path|
-                   PluginFile.new(file_path)
+                   PluginFile.new(Config.instance.pretty_path_from_project(file_path))
                  end
                else
                  raise LoadError, "#{self}: Can't find anything for #{path}"
                end
+
+      # expand abs_source_paths to every file
+      @files.each do |file|
+        file.abs_source_path = File.expand_path(file.source_path, Config.instance.project_path)
+      end
     end
 
     # @param [Class] klass  base class of all instances

data/lib/epuber/server.rb

@@ -105,6 +105,8 @@ module Epuber
     # @return nil
     #
     def self.run!(book, target, verbose: false)
+      Encoding.default_internal = Encoding::UTF_8 if Encoding.default_internal.nil?
+
       self.book = book
       self.target = target
       self.verbose = verbose
@@ -118,7 +120,13 @@ module Epuber
         $stderr = old_stderr
         puts "Started development server on #{server.host}:#{server.port}"
 
-        yield URI("http://#{server.host}:#{server.port}") if block_given?
+        host = if server.host == '0.0.0.0'
+                 'localhost'
+               else
+                 server.host
+               end
+
+        yield URI("http://#{host}:#{server.port}") if block_given?
       end
     end
 
@@ -306,6 +314,21 @@ module Epuber
       head.add_child(node)
     end
 
+    # @param html_doc [Nokogiri::HTML::Document]
+    # @param key [String]
+    # @param value [String]
+    #
+    def add_meta_to_head(name, content, html_doc, force: false)
+      head = html_doc.at_css('head')
+      meta = head.at_css("meta[name=\"#{name}\"]")
+      return if force == false && !meta.nil?
+
+      meta ||= html_doc.create_element('meta')
+      meta['name'] = name
+      meta['content'] = content
+      head.add_child(meta)
+    end
+
     def self.reload_bookspec
       last_target = target
       Config.instance.bookspec = nil
@@ -341,12 +364,13 @@ module Epuber
         @compilation_thread = nil
       end
 
+      @compilation_thread = Thread.new do
+        result = _compile_book
+        completion.call(result) unless completion.nil?
+      end
+      
       if completion.nil?
-        _compile_book
-      else
-        @compilation_thread = Thread.new do
-          completion.call(_compile_book)
-        end
+        @compilation_thread.join
       end
     end
 
@@ -387,7 +411,7 @@ module Epuber
     # @param _removed [Array<String>]
     #
     def self.changes_detected(_modified, _added, _removed)
-      all_changed = (_modified + _added + _removed).uniq
+      all_changed = (_modified + _added + _removed).uniq.map { |path| path.unicode_normalize }
 
       reload_bookspec if all_changed.any? { |file| file == book.file_path }
 
@@ -416,11 +440,11 @@ module Epuber
         # remove nil paths (for example bookspec can't be found so the relative path is nil)
         changed.compact!
 
-        if changed.size > 0 && changed.all? { |file| file.end_with?(*Epuber::Compiler::FileFinders::GROUP_EXTENSIONS[:style]) }
-          notify_clients(:styles, changed)
-        else
+        # if changed.size > 0 && changed.all? { |file| file.end_with?(*Epuber::Compiler::FileFinders::GROUP_EXTENSIONS[:style]) }
+          # notify_clients(:styles, changed)
+        # else
           notify_clients(:reload, changed)
-        end
+        # end
       end
     end
 

data/lib/epuber/server/handlers.rb

@@ -19,6 +19,7 @@ module Epuber
       add_file_to_head(:style, html_doc, 'book_content.styl')
 
       add_file_to_head(:js, html_doc, 'support.coffee')
+      add_meta_to_head(:viewport, 'width=device-width, initial-scale=1.0', html_doc)
       add_auto_refresh_script(html_doc)
 
       unless file_resolver.nil?
@@ -31,7 +32,7 @@ module Epuber
         end
       end
 
-      [200, html_doc.to_html]
+      [200, html_doc.to_xhtml]
     end
 
     # @param [String] file_name  name of the file located in ./pages/

data/lib/epuber/server/pages/book.bade

@@ -5,11 +5,15 @@ mixin book_meta(key, format: nil)
 	tr
 		- value = book.send(key.to_sym)
 		- if value.is_a?(Array)
-			- value = value.map(&format).join(', ')
+			- value = value.compact.map(&format).join(', ')
 		- end
 
 		- unless value.nil?
 			td.book_meta_key= key.gsub('_', ' ')
+			- if value.to_s.empty?
+				- value = ' '
+			- end
+
 			td.book_meta_value= value
 		- end
 
@@ -67,7 +71,7 @@ mixin iterate_spine(toc_item)
 
 
 		+section('Targets')
-			- book.targets.each do |b_target|
+			- book.all_targets.each do |b_target|
 				p(class: 'target_selected' if target == b_target): a(href: "/change_target/#{b_target.name}")= b_target.name
 			- end
 

data/lib/epuber/server/pages/common.bade

@@ -19,22 +19,20 @@ mixin body_header(current)
     #header
         #header_content
             ul
-                li(class: 'selected' if current == 'home' || current.nil?): a(href: '/')= book.title
+                li(class: 'selected' if current == 'home' || current.nil?): a(href: '/') Home
                 li(class: 'selected' if current == 'toc'): a(href: '/toc/') Toc
                 li(class: 'selected' if current == 'files'): a(href: '/files/') Files
 
 mixin body_footer
 	#footer
-		p Epuber v#{Epuber::VERSION} | © #{Time.now.year} Roman Kříž
+		p
+		    a(href: Epuber::HOME_URL) Epuber v#{Epuber::VERSION}
+		    |  | © #{Time.now.year} Roman Kříž
 
 mixin page(title: nil, header_id: nil)
 	html
     	head
-    		- if title.nil?
-    			title #{book.title} | Epuber
-    		- else
-    			title #{title} | #{book.title} | Epuber
-    		- end
+    		title= [title, book.title, 'Epuber'].compact.reject(&:empty?).join(' | ')
     		link(rel: "stylesheet", type: "text/css", href: "/server/raw/basic.styl")
     		<script type="text/javascript" charset="utf-8" src="/server/raw/vendor/bower/jquery/jquery.min.js"></script>
     		<script type="text/javascript" charset="utf-8" src="/server/raw/vendor/bower/spin/spin.js"></script>

data/lib/epuber/user_interface.rb

@@ -33,10 +33,10 @@ module Epuber
     # @param [Bool] backtrace  output backtrace locations, nil == automatic, true == always and false == never
     #
     def self.error(message, location: nil)
-      $stdout.puts unless @last_processing_file_line.nil?
-
-      $stdout.puts(_format_message(:error, message, location: location))
-      _print_backtrace(location.try(:backtrace_locations) || message.try(:backtrace_locations) || caller_locations, location: location) if current_command && current_command.verbose?
+      _clear_processing_line_for_new_output do
+        $stdout.puts(_format_message(:error, message, location: location))
+        _print_backtrace(location.try(:backtrace_locations) || message.try(:backtrace_locations) || caller_locations, location: location) if current_command && current_command.verbose?
+      end
     end
 
     # @param [String] message message of the error
@@ -107,6 +107,36 @@ module Epuber
       @current_file = nil
     end
 
+    # @param [Compiler::FileTypes::AbstractFile] file
+    # @param [String] step_name
+    # @param [Fixnum] time
+    #
+    def self.print_step_processing_time(step_name, time = nil)
+      if !current_command || !current_command.debug_steps_times
+        return yield
+      end
+
+      remove_processing_file_line
+
+      if block_given?
+        start = Time.now
+        returned_value = yield
+
+        time = Time.now - start
+      end
+
+      info_text = "Step #{step_name} took #{time * 1000} ms"
+      message = if @current_file.nil?
+                  "▸ #{info_text}"
+                else
+                  "▸ #{@current_file.source_path}: #{info_text}"
+                end
+
+      $stdout.puts(_format_message(:debug, message))
+
+      returned_value
+    end
+
     private
 
     def self._clear_processing_line_for_new_output
@@ -145,6 +175,8 @@ module Epuber
         Location.new(obj.document.file_path, obj.line)
       when Location
         obj
+      when Epuber::Compiler::FileTypes::AbstractFile
+        Location.new(obj.source_path, nil)
       end
     end