epuber 0.7.4 → 0.9.0

data/lib/epuber/compiler/xhtml_processor.rb

@@ -13,7 +13,8 @@ module Epuber
 
       # Method for parsing incomplete XML, supports multiple root elements
       #
-      # @warning Because of nature of XML, when input string don't contain root element, it will create own called `body`, since it will be used in next steps.
+      # @warning Because of nature of XML, when input string don't contain root element, it will create own called
+      # `body`, since it will be used in next steps.
       #
       # @param [String] text  input XHTML text
       #
@@ -23,7 +24,8 @@ module Epuber
         text = text.dup
 
         if /\A[\n\r ]+(<\?xml)/ =~ text
-          UI.warning('XML header must be at the beginning of document', location: UI::Location.new(file_path, 1))
+          UI.warning('XML header must be at the beginning of document',
+                     location: UI::Location.new(path: file_path, lineno: 1))
 
           text = text.lstrip
         end
@@ -37,20 +39,19 @@ module Epuber
 
         doctypes = []
         while /(\n|\?>|\A)?(<!DOCTYPE [^>]*>\n*)/ =~ text
-          doctypes << $2.strip
+          doctypes << ::Regexp.last_match(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
+        before += "\n" unless before.empty?
 
         parse_options = Nokogiri::XML::ParseOptions::DEFAULT_XML |
                         Nokogiri::XML::ParseOptions::NOERROR | # to silence any errors or warnings printing into console
-                        Nokogiri::XML::ParseOptions::NOWARNING
+                        Nokogiri::XML::ParseOptions::NOWARNING |
+                        Nokogiri::XML::ParseOptions::NOENT
 
         doc = Nokogiri::XML("#{before}<root>#{text}</root>", file_path, nil, parse_options)
         text_for_errors = before + text
@@ -82,11 +83,10 @@ module Epuber
       end
 
       def self.xml_document_from_string(text, file_path = nil)
-        xml, errros = self.xml_doc_from_str_with_errors(text, file_path)
+        xml, = xml_doc_from_str_with_errors(text, file_path)
         xml
       end
 
-
       # Method to add all missing items in XML root
       #
       # Required items:
@@ -137,10 +137,10 @@ module Epuber
         end
 
         # https://github.com/IDPF/epubcheck/issues/631
-        if epub_version < 3.0
-          xhtml_doc.internal_subset.remove unless xhtml_doc.internal_subset.nil?
-          xhtml_doc.create_internal_subset('html', "-//W3C//DTD XHTML 1.1//EN", "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd")
-        end
+        return unless epub_version < 3.0
+
+        xhtml_doc.internal_subset&.remove
+        xhtml_doc.create_internal_subset('html', '-//W3C//DTD XHTML 1.1//EN', 'http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd')
       end
 
       # Method for adding style sheets with links, method will not add duplicate items
@@ -151,7 +151,7 @@ module Epuber
       # @return nil
       #
       def self.add_styles(xhtml_doc, styles)
-        head  = xhtml_doc.at_css('html > head')
+        head = xhtml_doc.at_css('html > head')
         old_links = head.css('link[rel="stylesheet"]').map { |node| node['href'] }
 
         links_to_add = styles - old_links
@@ -169,7 +169,7 @@ module Epuber
       # @return nil
       #
       def self.add_scripts(xhtml_doc, scripts)
-        head  = xhtml_doc.at_css('html > head')
+        head = xhtml_doc.at_css('html > head')
         old_links = head.css('script').map { |node| node['src'] }
 
         links_to_add = scripts - old_links
@@ -195,7 +195,8 @@ module Epuber
       # Method which will resolve path to file from pattern
       #
       # @param [String] path  pattern or path of the file
-      # @param [Symbol | Array<Symbol>] groups  groups of the searching file, could be for example :image when searching for file from tag <img>
+      # @param [Symbol | Array<Symbol>] groups  groups of the searching file, could be for example :image when searching
+      #                                         for file from tag <img>
       # @param [String] file_path  path to file from which is searching for other file
       # @param [Epuber::Compiler::FileFinder] file_finder  finder for searching for files
       #
@@ -233,7 +234,8 @@ module Epuber
       # @param [Nokogiri::XML::Document] xhtml_doc  input XML document to work with
       # @param [String] tag_name  CSS selector for tag
       # @param [String] attribute_name  name of attribute
-      # @param [Symbol | Array<Symbol>] groups  groups of the searching file, could be for example :image when searching for file from tag <img>
+      # @param [Symbol | Array<Symbol>] groups  groups of the searching file, could be for example :image when searching
+      #                                         for file from tag <img>
       # @param [String] file_path  path to file from which is searching for other file
       # @param [Epuber::Compiler::FileFinder] file_finder  finder for searching for files
       #
@@ -243,22 +245,21 @@ module Epuber
         founded_links = []
 
         xhtml_doc.css("#{tag_name}[#{attribute_name}]").each do |node|
-          begin
-            src = node[attribute_name]
-            # @type [String] src
+          src = node[attribute_name]
+          # @type [String] src
 
-            next if src.nil?
+          next if src.nil?
+          next if src.start_with?('$')
 
-            target_file = resolved_link_to_file(src, groups, file_path, file_finder)
-            founded_links << target_file
+          target_file = resolved_link_to_file(src, groups, file_path, file_finder)
+          founded_links << target_file
 
-            node[attribute_name] = target_file.to_s
-          rescue UnparseableLinkError, FileFinders::FileNotFoundError, FileFinders::MultipleFilesFoundError => e
-            UI.warning(e.to_s, location: node)
+          node[attribute_name] = target_file.to_s
+        rescue UnparseableLinkError, FileFinders::FileNotFoundError, FileFinders::MultipleFilesFoundError => e
+          UI.warning(e.to_s, location: node)
 
-            # skip not found files
-            next
-          end
+          # skip not found files
+          next
         end
 
         founded_links
@@ -349,7 +350,6 @@ module Epuber
 
           begin
             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, resource_group, dirname, file_resolver.source_finder).to_s
@@ -361,8 +361,7 @@ module Epuber
               file.path_type = :manifest
               file_resolver.add_file(file)
 
-              new_path = FileResolver::renamed_file_with_path(new_path)
-
+              new_path = FileResolver.renamed_file_with_path(new_path)
             rescue UnparseableLinkError, FileFinders::FileNotFoundError, FileFinders::MultipleFilesFoundError => e
               UI.warning(e.to_s, location: img)
 
@@ -373,6 +372,38 @@ module Epuber
           img[attribute_name] = new_path
         end
       end
+
+      # @param [Nokogiri::XML::Document] xhtml_doc  input XML document to work with
+      # @return [Array<Nokogiri::XML::Node>] list of nodes with global ids
+      #
+      def self.find_global_ids_nodes(xhtml_doc)
+        xhtml_doc
+          .css('[id^="$"]')
+      end
+
+      # @param [Nokogiri::XML::Document] xhtml_doc  input XML document to work with
+      # @return [Array<string>] list of global ids (without dollar signs)
+      #
+      def self.find_global_ids(xhtml_doc)
+        find_global_ids_nodes(xhtml_doc)
+          .map { |node| node['id'][1..-1] }
+      end
+
+      # @param [Nokogiri::XML::Document] xhtml_doc  input XML document to work with
+      # @return [Array<Nokogiri::XML::Node>] list of nodes with global links
+      #
+      def self.find_global_links_nodes(xhtml_doc)
+        xhtml_doc
+          .css('[href^="$"]')
+      end
+
+      # @param [Nokogiri::XML::Document] xhtml_doc  input XML document to work with
+      # @return [Array<string>] list of global ids (without dollar signs)
+      #
+      def self.find_global_links(xhtml_doc)
+        find_global_links_nodes(xhtml_doc)
+          .map { |node| node['href'][1..-1] }
+      end
     end
   end
 end

data/lib/epuber/compiler.rb

@@ -39,8 +39,8 @@ module Epuber
     #
     attr_reader :compilation_context
 
-    # @param book [Epuber::Book::Book]
-    # @param target [Epuber::Book::Target]
+    # @param [Epuber::Book::Book] book
+    # @param [Epuber::Book::Target] target
     #
     def initialize(book, target)
       @book = book
@@ -50,7 +50,7 @@ module Epuber
 
     # Compile target to build folder
     #
-    # @param build_folder [String] path to folder, where will be stored all compiled files
+    # @param [String] build_folder path to folder, where will be stored all compiled files
     # @param [Bool] check should run non-release checkers
     # @param [Bool] write should perform transformations of source files and write them back
     # @param [Bool] release this is release build
@@ -71,22 +71,35 @@ module Epuber
 
         FileUtils.mkdir_p(build_folder)
 
-        puts "  handling target #{@target.name.inspect} in build dir `#{Config.instance.pretty_path_from_project(build_folder)}`"
+        UI.puts "  #{<<~MSG}"
+          building target #{@target.name.inspect} (build dir: #{Config.instance.pretty_path_from_project(build_folder)})
+        MSG
 
-        file_resolver.add_file(FileTypes::SourceFile.new(Config.instance.pretty_path_from_project(@book.file_path).to_s))
+        file_resolver.add_file(FileTypes::SourceFile.new(Config.instance.pretty_path_from_project(@book.file_path)))
         compilation_context.plugins
 
+        # validate bookspec
+        compilation_context.perform_plugin_things(Checker, :bookspec) do |checker|
+          checker.call(@book, compilation_context)
+        end
+
         parse_toc_item(@target.root_toc)
         parse_target_file_requests
 
         process_all_target_files
         generate_other_files
 
+        compilation_context.perform_plugin_things(Transformer, :after_all_text_files) do |transformer|
+          transformer.call(@book, compilation_context)
+        end
+
+        process_global_ids
+
         # 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 }
+        source_paths = file_resolver.files.select { |a| a.is_a?(FileTypes::SourceFile) }.map(&: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
@@ -101,7 +114,7 @@ module Epuber
 
     # Archives current target files to epub
     #
-    # @param path [String] path to created archive
+    # @param [String] path path to created archive
     #
     # @return [String] path
     #
@@ -118,7 +131,7 @@ module Epuber
             old_paths = zip_file.instance_eval { @entry_set.entries.map(&:name) }
             diff = old_paths - new_paths
             diff.each do |file_to_remove|
-              puts "DEBUG: removing file from result EPUB: #{file_to_remove}" if compilation_context.verbose?
+              UI.puts "DEBUG: removing file from result EPUB: #{file_to_remove}" if compilation_context.verbose?
               zip_file.remove(file_to_remove)
             end
           end
@@ -147,7 +160,7 @@ module Epuber
       epub_name += @book.build_version.to_s unless @book.build_version.nil?
       epub_name += "-#{@target.name}" if @target != @book.default_target
       epub_name += "-#{configuration_suffix}" unless configuration_suffix.nil?
-      epub_name + '.epub'
+      "#{epub_name}.epub"
     end
 
 
@@ -158,21 +171,25 @@ module Epuber
     def remove_empty_folders
       Dir.chdir(@file_resolver.destination_path) do
         Dir.glob('**/*')
-          .select { |d| File.directory?(d) }
-          .select { |d| (Dir.entries(d) - %w(. ..)).empty? }
-          .each do |d|
-          puts "DEBUG: removing empty folder `#{d}`" if compilation_context.verbose?
-          Dir.rmdir(d)
-        end
+           .select { |d| File.directory?(d) }
+           .select { |d| (Dir.entries(d) - %w[. ..]).empty? }
+           .each do |d|
+             UI.puts "DEBUG: removing empty folder `#{d}`" if compilation_context.verbose?
+             Dir.rmdir(d)
+           end
       end
     end
 
     # @return nil
     #
     def remove_unnecessary_files
-      unnecessary_paths = @file_resolver.unneeded_files_in_destination.map { |path| File.join(@file_resolver.destination_path, path) }
+      unnecessary_paths = @file_resolver.unneeded_files_in_destination.map do |path|
+        File.join(@file_resolver.destination_path, path)
+      end
       unnecessary_paths.each do |path|
-        puts "DEBUG: removing unnecessary file: `#{Config.instance.pretty_path_from_project(path)}`" if compilation_context.verbose?
+        if compilation_context.verbose?
+          UI.puts "DEBUG: removing unnecessary file: `#{Config.instance.pretty_path_from_project(path)}`"
+        end
 
         File.delete(path)
       end
@@ -201,11 +218,11 @@ module Epuber
       @file_resolver.add_file(container_xml)
       process_file(container_xml)
 
-      if @target.epub_version >= 2.0 && @target.epub_version < 3.0
-        ibooks_options = FileTypes::IBooksDisplayOptionsFile.new
-        @file_resolver.add_file(ibooks_options)
-        process_file(ibooks_options)
-      end
+      return unless @target.epub_version >= 2.0 && @target.epub_version < 3.0
+
+      ibooks_options = FileTypes::IBooksDisplayOptionsFile.new
+      @file_resolver.add_file(ibooks_options)
+      process_file(ibooks_options)
     end
 
     # @return nil
@@ -239,6 +256,7 @@ module Epuber
       # 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
 
@@ -247,7 +265,7 @@ module Epuber
 
       # add all activated plugin files
       paths += compilation_context.plugins.map do |plugin|
-        plugin.files.map { |p_file| p_file.source_path }
+        plugin.files.map(&:source_path)
       end.flatten
 
       # add dependencies to databases
@@ -272,7 +290,7 @@ module Epuber
       UI.processing_files_done
     end
 
-    # @param toc_item [Epuber::Book::TocItem]
+    # @param [Epuber::Book::TocItem] toc_item
     #
     def parse_toc_item(toc_item)
       unless toc_item.file_request.nil?
@@ -286,7 +304,41 @@ module Epuber
       end
     end
 
-    # @param cmd [String]
+    def process_global_ids
+      xhtml_files = @file_resolver.files.select { |file| file.is_a?(FileTypes::XHTMLFile) }
+      global_ids = validate_global_ids(xhtml_files)
+
+      xhtml_files.each do |file|
+        file.process_global_ids(compilation_context, global_ids)
+      end
+    end
+
+    # Validates duplicity of global ids in all files + returns map of global ids to files
+    #
+    # @param [Array<FileTypes::XHTMLFile>] xhtml_files
+    # @return [Hash<String, FileTypes::XHTMLFile>]
+    #
+    def validate_global_ids(xhtml_files)
+      map = {}
+      xhtml_files.each do |file|
+        file.global_ids.each do |id|
+          if map.key?(id)
+            message = "Duplicate global id `#{id}` in file `#{file.source_path}`."
+            if compilation_context.release_build?
+              UI.error!(message)
+            else
+              UI.warning("#{message} Will fail during release build.")
+            end
+          end
+
+          map[id] = file
+        end
+      end
+
+      map
+    end
+
+    # @param [String] cmd
     #
     # @return [void]
     #

data/lib/epuber/config.rb

@@ -14,7 +14,7 @@ module Epuber
       @project_path ||= Dir.pwd.unicode_normalize
     end
 
-    # @param of_file [String] absolute path to file
+    # @param [String] of_file absolute path to file
     #
     # @return [String] relative path to file from root of project
     #
@@ -60,9 +60,11 @@ module Epuber
     #
     # @return [Epuber::Book]
     #
-    def bookspec=(bookspec)
-      @bookspec = bookspec
-    end
+    attr_writer :bookspec
+
+    # @return [Boolean]
+    #
+    attr_accessor :release_build
 
     # @return [Epuber::Lockfile]
     #
@@ -82,7 +84,7 @@ module Epuber
       bookspec_lockfile.write_to_file
     end
 
-    # @param target [Epuber::Book::Target]
+    # @param [Epuber::Book::Target] target
     #
     # @return [String]
     #
@@ -90,7 +92,7 @@ module Epuber
       File.join(working_path, 'build', target.name.to_s)
     end
 
-    # @param target [Epuber::Book::Target]
+    # @param [Epuber::Book::Target] target
     #
     # @return [String]
     #
@@ -122,12 +124,16 @@ module Epuber
 
     def warn_for_outdated_versions!
       if bookspec_lockfile.epuber_version > Epuber::VERSION
-        UI.warning('Warning: the running version of Epuber is older than the version that created the lockfile. We suggest you upgrade to the latest version of Epuber by running `gem install epuber`.')
+        UI.warning(<<~MSG.rstrip)
+          Warning: the running version of Epuber is older than the version that created the lockfile. We suggest you upgrade to the latest version of Epuber by running `gem install epuber`.
+        MSG
       end
 
-      if bookspec_lockfile.bade_version && bookspec_lockfile.bade_version > Bade::VERSION
-        UI.warning('Warning: the running version of Bade is older than the version that created the lockfile. We suggest you upgrade to the latest version of Bade by running `gem install bade`.')
-      end
+      return unless bookspec_lockfile.bade_version && bookspec_lockfile.bade_version > Bade::VERSION
+
+      UI.warning(<<~MSG.rstrip)
+        Warning: the running version of Bade is older than the version that created the lockfile. We suggest you upgrade to the latest version of Bade by running `gem install bade`.
+      MSG
     end
 
     def same_version_as_last_run?

data/lib/epuber/dsl/attribute.rb

@@ -17,7 +17,7 @@ module Epuber
 
       # Returns a new attribute initialized with the given options.
       #
-      # @param name [Symbol]
+      # @param [Symbol] name
       #
       # @see #name
       #
@@ -109,25 +109,25 @@ module Epuber
       #         is not specified.
       #
       attr_reader :required
-      alias_method :required?, :required
+      alias required? required
 
       # @return [Bool] whether the attribute should be specified only on the root specification.
       #
       attr_reader :root_only
-      alias_method :root_only?, :root_only
+      alias root_only? root_only
 
 
       # @return [Bool] whether there should be a singular alias for the attribute writer.
       #
       attr_reader :singularize
-      alias_method :singularize?, :singularize
+      alias singularize? singularize
 
       # @return [Bool] whether the attribute describes file patterns.
       #
       # @note   This is mostly used by the linter.
       #
       attr_reader :file_patterns
-      alias_method :file_patterns?, :file_patterns
+      alias file_patterns? file_patterns
 
       # @return [Bool] defines whether the attribute reader should join the values with the parent.
       #
@@ -184,25 +184,24 @@ module Epuber
           raise StandardError, "Can't set `#{name}` attribute for subspecs (in `#{spec.name}`)."
         end
 
-        if keys
-          value.keys.each do |key|
-            unless allowed_keys.include?(key)
-              raise StandardError, "Unknown key `#{key}` for #{self}. Allowed keys: `#{allowed_keys.inspect}`"
-            end
-          end
-        end
+        return unless keys
 
         # @return [Array] the flattened list of the allowed keys for the hash of a given specification.
         #
-        def allowed_keys
+        allowed_keys = lambda do
           if keys.is_a?(Hash)
             keys.keys.concat(keys.values.flatten.compact)
           else
             keys
           end
         end
-      end
 
+        value.each_key do |key|
+          unless allowed_keys.include?(key)
+            raise StandardError, "Unknown key `#{key}` for #{self}. Allowed keys: `#{allowed_keys.inspect}`"
+          end
+        end
+      end
 
       #---------------------------------------------------------------------#
 
@@ -221,15 +220,14 @@ module Epuber
           validate_type(value)
         rescue StandardError
           raise if @auto_convert.nil?
+
           dest_class = @auto_convert[value.class]
 
           if dest_class.nil?
             array_keys           = @auto_convert.select { |k, _v| k.is_a?(Array) }
             array_keys_with_type = array_keys.select { |k, _v| k.any? { |klass| value.class <= klass } }
 
-            if array_keys_with_type.count > 0
-              dest_class = array_keys_with_type.values.first
-            end
+            dest_class = array_keys_with_type.values.first if array_keys_with_type.count.positive?
           end
 
           if dest_class.respond_to?(:call)
@@ -241,7 +239,8 @@ module Epuber
           elsif dest_class.respond_to?(:new)
             return dest_class.new(value)
           else
-            raise StandardError, "Object/class #{dest_class} doesn't support any convert method (#call, .parse or implicit .new)"
+            raise StandardError,
+                  "Object/class #{dest_class} doesn't support any convert method (#call, .parse or implicit .new)"
           end
         end
 

data/lib/epuber/dsl/attribute_support.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-
 module Epuber
   module DSL
     module AttributeSupport
@@ -10,8 +9,8 @@ module Epuber
       #     attribute :name
       #     attribute :title, required: true, inherited: true
       #
-      # @param name [Symbol] attribute name
-      # @param options [Hash]
+      # @param [Symbol] name attribute name
+      # @param [Hash] options
       #
       # @see Attribute
       #
@@ -45,8 +44,8 @@ module Epuber
         end
       end
 
-      # @param name [Symbol]
-      # @param attr [Epuber::DSL::Attribute]
+      # @param [Symbol] name
+      # @param [Epuber::DSL::Attribute] attr
       #
       # @return nil
       #
@@ -86,8 +85,9 @@ module Epuber
           else
             begin
               @attributes_values[key] = attr.converted_value(value)
-            rescue Exception => e
-              UI.warning("Invalid value `#{value}` for attribute `#{name}`, original error `#{e}`", location: caller_locations[1])
+            rescue StandardError => e
+              UI.warning("Invalid value `#{value}` for attribute `#{name}`, original error `#{e}`",
+                         location: caller_locations[1])
             end
           end
         end

data/lib/epuber/dsl/object.rb

@@ -49,17 +49,16 @@ module Epuber
 
           next unless attr.required? && value.nil?
 
-          if attr.singularize?
-            raise ValidationError, "missing required attribute `#{key.to_s.singularize}|#{key}`"
-          else
-            raise ValidationError, "missing required attribute `#{key}`"
-          end
+          raise ValidationError, "missing required attribute `#{key.to_s.singularize}|#{key}`" if attr.singularize?
+
+
+          raise ValidationError, "missing required attribute `#{key}`"
         end
       end
 
       # Creates new instance by parsing ruby code from file
       #
-      # @param file_path [String]
+      # @param [String] file_path
       #
       # @return [Self]
       #
@@ -69,26 +68,21 @@ module Epuber
 
       # Creates new instance by parsing ruby code from string
       #
-      # @param string [String]
+      # @param [String] string
       #
       # @return [Self]
       #
       def self.from_string(string, file_path = nil)
-        # rubocop:disable Lint/Eval
         obj = if file_path
-                eval(string, nil, file_path)
+                eval(string, nil, file_path) # rubocop:disable Security/Eval
               else
-                eval(string)
+                eval(string) # rubocop:disable Security/Eval
               end
-        # rubocop:enable Lint/Eval
 
         unless obj.is_a?(self)
           msg = "Invalid object #{obj.class}, expected object of class #{self}"
 
-          if file_path
-            msg += ", loaded from file #{file_path}"
-
-          end
+          msg += ", loaded from file #{file_path}" if file_path
 
           raise StandardError, msg
         end
@@ -121,6 +115,10 @@ module Epuber
       #
       attr_accessor :attributes_values
 
+      def respond_to_missing?(name, include_private = false)
+        @attributes_values.key?(name) || super
+      end
+
       # Raise exception when there is used some unknown method or attribute
       #
       # This is just for creating better message in raised exception
@@ -129,9 +127,13 @@ module Epuber
       #
       def method_missing(name, *args)
         if /([^=]+)=?/ =~ name
-          attr_name = $1
+          attr_name = ::Regexp.last_match(1)
           location = caller_locations.first
-          raise NameError, "Unknown attribute or method `#{attr_name}` for class `#{self.class}` in file `#{location.path}:#{location.lineno}`"
+          message = <<~MSG
+            Unknown attribute or method `#{attr_name}` for class `#{self.class}` in file `#{location.path}:#{location.lineno}`
+          MSG
+
+          raise NameError, message
         else
           super
         end