prawn-html 0.3.0 → 0.5.0

data/lib/prawn_html/html_parser.rb

@@ -4,30 +4,38 @@ require 'oga'
 
 module PrawnHtml
   class HtmlParser
+    REGEXP_STYLES = /\s*([^{\s]+)\s*{\s*([^}]*?)\s*}/m.freeze
+
     # Init the HtmlParser
     #
-    # @param pdf [Prawn::Document] Target Prawn PDF document
-    def initialize(pdf)
+    # @param renderer [DocumentRenderer] document renderer
+    # @param ignore_content_tags [Array] array of tags (symbols) to skip their contents while preparing the PDF document
+    def initialize(renderer, ignore_content_tags: %i[script style])
       @processing = false
-      @renderer = DocumentRenderer.new(pdf)
+      @ignore = false
+      @ignore_content_tags = ignore_content_tags
+      @renderer = renderer
+      @styles = {}
     end
 
-    # Processes HTML and renders it on the PDF document
+    # Processes HTML and renders it
     #
     # @param html [String] The HTML content to process
     def process(html)
       @processing = !html.include?('<body')
-      doc = Oga.parse_html(html)
-      traverse_nodes(doc.children)
+      @document = Oga.parse_html(html)
+      traverse_nodes(document.children)
       renderer.flush
     end
 
     private
 
-    attr_reader :processing, :renderer
+    attr_reader :document, :ignore, :processing, :renderer, :styles
 
     def traverse_nodes(nodes)
       nodes.each do |node|
+        next if node.is_a?(Oga::XML::Comment)
+
         element = node_open(node)
         traverse_nodes(node.children) if node.children.any?
         node_close(element) if element
@@ -37,21 +45,27 @@ module PrawnHtml
     def node_open(node)
       tag = node.is_a?(Oga::XML::Element) && init_element(node)
       return unless processing
+      return IgnoredTag.new(tag) if ignore
       return renderer.on_text_node(node.text) unless tag
 
-      attributes = prepare_attributes(node)
-      renderer.on_tag_open(tag, attributes)
+      renderer.on_tag_open(tag, attributes: prepare_attributes(node), element_styles: styles[node])
     end
 
     def init_element(node)
       node.name.downcase.to_sym.tap do |tag_name|
         @processing = true if tag_name == :body
-        renderer.assign_document_styles(extract_styles(node.text)) if tag_name == :style
+        @ignore = true if @processing && @ignore_content_tags.include?(tag_name)
+        process_styles(node.text) if tag_name == :style
       end
     end
 
-    def extract_styles(text)
-      text.scan(/\s*([^{\s]+)\s*{\s*([^}]*?)\s*}/m).to_h
+    def process_styles(text_styles)
+      hash_styles = text_styles.scan(REGEXP_STYLES).to_h
+      hash_styles.each do |selector, rule|
+        document.css(selector).each do |node|
+          styles[node] = rule
+        end
+      end
     end
 
     def prepare_attributes(node)
@@ -61,10 +75,21 @@ module PrawnHtml
     end
 
     def node_close(element)
-      renderer.on_tag_close(element) if @processing
+      if processing
+        renderer.on_tag_close(element) unless ignore
+        @ignore = false if ignore && @ignore_content_tags.include?(element.tag)
+      end
       @processing = false if element.tag == :body
     end
   end
 
+  class IgnoredTag
+    attr_accessor :tag
+
+    def initialize(tag_name)
+      @tag = tag_name
+    end
+  end
+
   HtmlHandler = HtmlParser
 end

data/lib/prawn_html/pdf_wrapper.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module PrawnHtml
+  class PdfWrapper
+    extend Forwardable
+
+    def_delegators :@pdf, :start_new_page
+
+    # Wrapper for Prawn PDF Document
+    #
+    # @param pdf_document [Prawn::Document] PDF document to wrap
+    def initialize(pdf_document)
+      @pdf = pdf_document
+    end
+
+    # Advance the cursor
+    #
+    # @param move_down [Float] Quantity to advance (move down)
+    def advance_cursor(move_down)
+      return if !move_down || move_down == 0
+
+      pdf.move_down(move_down)
+    end
+
+    # Calculate the height of a buffer of items
+    #
+    # @param buffer [Array] Buffer of items
+    # @param options [Hash] Output options
+    #
+    # @return [Float] calculated height
+    def calc_buffer_height(buffer, options)
+      pdf.height_of_formatted(buffer, options)
+    end
+
+    # Calculate the width of a buffer of items
+    #
+    # @param buffer [Array] Buffer of items
+    #
+    # @return [Float] calculated width
+    def calc_buffer_width(buffer)
+      width = 0
+      buffer.each do |item|
+        font_family = item[:font] || pdf.font.name
+        pdf.font(font_family, size: item[:size] || pdf.font_size) do
+          width += pdf.width_of(item[:text], inline_format: true)
+        end
+      end
+      width
+    end
+
+    # Height of the page
+    #
+    # @return [Float] height
+    def page_height
+      pdf.bounds.height
+    end
+
+    # Width of the page
+    #
+    # @return [Float] width
+    def page_width
+      pdf.bounds.width
+    end
+
+    # Draw a rectangle
+    #
+    # @param x [Float] left position of the rectangle
+    # @param y [Float] top position of the rectangle
+    # @param width [Float] width of the rectangle
+    # @param height [Float] height of the rectangle
+    # @param color [String] fill color
+    def draw_rectangle(x:, y:, width:, height:, color:)
+      current_fill_color = pdf.fill_color
+      pdf.fill_color = color
+      pdf.fill_rectangle([y, x], width, height)
+      pdf.fill_color = current_fill_color
+    end
+
+    # Horizontal line
+    #
+    # @param color [String] line color
+    # @param dash [Integer|Array] integer or array of integer with dash options
+    def horizontal_rule(color:, dash:)
+      current_color = pdf.stroke_color
+      pdf.dash(dash) if dash
+      pdf.stroke_color = color if color
+      pdf.stroke_horizontal_rule
+      pdf.stroke_color = current_color if color
+      pdf.undash if dash
+    end
+
+    # Image
+    #
+    # @param src [String] image source path
+    # @param options [Hash] hash of options
+    def image(src, options = {})
+      return unless src
+
+      pdf.image(src, options)
+    end
+
+    # Output to the PDF document
+    #
+    # @param buffer [Array] array of text items
+    # @param options [Hash] hash of options
+    # @param bounding_box [Array] bounding box arguments, if bounded
+    def puts(buffer, options, bounding_box: nil, left_indent: 0)
+      return output_buffer(buffer, options, left_indent: left_indent) unless bounding_box
+
+      current_y = pdf.cursor
+      pdf.bounding_box(*bounding_box) do
+        output_buffer(buffer, options, left_indent: left_indent)
+      end
+      pdf.move_cursor_to(current_y)
+    end
+
+    # Underline
+    #
+    # @param x1 [Float] left position of the line
+    # @param x2 [Float] right position of the line
+    # @param y [Float] vertical position of the line
+    def underline(x1:, x2:, y:)
+      pdf.stroke do
+        pdf.line [x1, y], [x2, y]
+      end
+    end
+
+    private
+
+    attr_reader :pdf
+
+    def output_buffer(buffer, options, left_indent:)
+      formatted_text = proc { pdf.formatted_text(buffer, options) }
+      return formatted_text.call if left_indent == 0
+
+      pdf.indent(left_indent, 0, &formatted_text)
+    end
+  end
+end

data/lib/prawn_html/tag.rb

@@ -2,7 +2,11 @@
 
 module PrawnHtml
   class Tag
-    TAG_CLASSES = %w[A B Body Br Del Div H Hr I Img Li Mark Ol P Small Span U Ul].freeze
+    CALLBACKS = {
+      'Background' => Callbacks::Background,
+      'StrikeThrough' => Callbacks::StrikeThrough
+    }.freeze
+    TAG_CLASSES = %w[A B Blockquote Body Br Code Del Div H Hr I Img Li Mark Ol P Pre Small Span Sub Sup U Ul].freeze
 
     attr_accessor :parent
     attr_reader :attrs, :tag
@@ -11,12 +15,11 @@ module PrawnHtml
     #
     # @param tag [Symbol] tag name
     # @param attributes [Hash] hash of element attributes
-    # @param document_styles [Hash] hash of document styles
-    def initialize(tag, attributes = {}, document_styles = {})
+    # @param options [Hash] options (container width/height/etc.)
+    def initialize(tag, attributes: {}, options: {})
       @tag = tag
-      element_styles = attributes.delete(:style)
+      @options = options
       @attrs = Attributes.new(attributes)
-      process_styles(document_styles, element_styles)
     end
 
     # Is a block tag?
@@ -35,6 +38,15 @@ module PrawnHtml
       block_styles
     end
 
+    # Process tag styles
+    #
+    # @param element_styles [String] extra styles to apply to the element
+    def process_styles(element_styles: nil)
+      attrs.merge_text_styles!(tag_styles, options: options) if respond_to?(:tag_styles)
+      attrs.merge_text_styles!(element_styles, options: options) if element_styles
+      attrs.merge_text_styles!(attrs.style, options: options)
+    end
+
     # Styles to apply on tag closing
     #
     # @return [Hash] hash of styles to apply
@@ -74,23 +86,6 @@ module PrawnHtml
 
     private
 
-    def evaluate_document_styles(document_styles)
-      selectors = [
-        tag.to_s,
-        attrs['class'] ? ".#{attrs['class']}" : nil,
-        attrs['id'] ? "##{attrs['id']}" : nil
-      ].compact!
-      document_styles.each_with_object({}) do |(sel, attributes), res|
-        res.merge!(attributes) if selectors.include?(sel)
-      end
-    end
-
-    def process_styles(document_styles, element_styles)
-      attrs.merge_styles!(attrs.process_styles(tag_styles)) if respond_to?(:tag_styles)
-      doc_styles = evaluate_document_styles(document_styles)
-      attrs.merge_styles!(doc_styles)
-      el_styles = Attributes.parse_styles(element_styles)
-      attrs.merge_styles!(attrs.process_styles(el_styles)) if el_styles
-    end
+    attr_reader :options
   end
 end

data/lib/prawn_html/tags/a.rb

@@ -6,7 +6,13 @@ module PrawnHtml
       ELEMENTS = [:a].freeze
 
       def tag_styles
-        attrs.href ? { 'href' => attrs.href } : {}
+        return unless attrs.href
+
+        <<~STYLES
+          color: #00E;
+          href: #{attrs.href};
+          text-decoration: underline;
+        STYLES
       end
     end
   end

data/lib/prawn_html/tags/b.rb

@@ -6,9 +6,7 @@ module PrawnHtml
       ELEMENTS = [:b, :strong].freeze
 
       def tag_styles
-        {
-          'font-weight' => 'bold'
-        }
+        'font-weight: bold'
       end
     end
   end

data/lib/prawn_html/tags/blockquote.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module PrawnHtml
+  module Tags
+    class Blockquote < Tag
+      ELEMENTS = [:blockquote].freeze
+
+      MARGIN_BOTTOM = 12.7
+      MARGIN_LEFT = 40.4
+      MARGIN_TOP = 12.7
+
+      def block?
+        true
+      end
+
+      def tag_styles
+        <<~STYLES
+          margin-bottom: #{MARGIN_BOTTOM}px;
+          margin-left: #{MARGIN_LEFT}px;
+          margin-top: #{MARGIN_TOP}px;
+        STYLES
+      end
+    end
+  end
+end

data/lib/prawn_html/tags/body.rb

@@ -4,6 +4,10 @@ module PrawnHtml
   module Tags
     class Body < Tag
       ELEMENTS = [:body].freeze
+
+      def block?
+        true
+      end
     end
   end
 end

data/lib/prawn_html/tags/br.rb

@@ -5,17 +5,16 @@ module PrawnHtml
     class Br < Tag
       ELEMENTS = [:br].freeze
 
-      BR_SPACING = 12
+      BR_SPACING = Utils.convert_size('17')
 
       def block?
         true
       end
 
       def custom_render(pdf, context)
-        return if context.last_text_node
+        return if context.last_text_node || context.previous_tag != :br
 
-        @spacing ||= Utils.convert_size(BR_SPACING.to_s)
-        pdf.move_down(@spacing)
+        pdf.advance_cursor(BR_SPACING)
       end
     end
   end

data/lib/prawn_html/tags/code.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PrawnHtml
+  module Tags
+    class Code < Tag
+      ELEMENTS = [:code].freeze
+
+      def tag_styles
+        'font-family: Courier'
+      end
+    end
+  end
+end

data/lib/prawn_html/tags/del.rb

@@ -6,9 +6,7 @@ module PrawnHtml
       ELEMENTS = [:del, :s].freeze
 
       def tag_styles
-        {
-          'callback' => Callbacks::StrikeThrough
-        }
+        'text-decoration: line-through'
       end
     end
   end

data/lib/prawn_html/tags/h.rb

@@ -6,30 +6,30 @@ module PrawnHtml
       ELEMENTS = [:h1, :h2, :h3, :h4, :h5, :h6].freeze
 
       MARGINS_TOP = {
-        h1: 25.5,
+        h1: 25,
         h2: 20.5,
-        h3: 19,
-        h4: 20,
+        h3: 18,
+        h4: 21.2,
         h5: 21.2,
-        h6: 23.5
+        h6: 22.8
       }.freeze
 
       MARGINS_BOTTOM = {
-        h1: 18.2,
-        h2: 17.5,
-        h3: 17.5,
-        h4: 22,
-        h5: 22,
-        h6: 26.5
+        h1: 15.8,
+        h2: 15.8,
+        h3: 15.8,
+        h4: 20,
+        h5: 21.4,
+        h6: 24.8
       }.freeze
 
       SIZES = {
-        h1: 31,
-        h2: 23.5,
-        h3: 18.2,
-        h4: 16,
+        h1: 31.5,
+        h2: 24,
+        h3: 18.7,
+        h4: 15.7,
         h5: 13,
-        h6: 10.5
+        h6: 10.8
       }.freeze
 
       def block?
@@ -37,12 +37,12 @@ module PrawnHtml
       end
 
       def tag_styles
-        @tag_styles ||= {
-          'font-size' => SIZES[tag].to_s,
-          'font-weight' => 'bold',
-          'margin-bottom' => MARGINS_BOTTOM[tag].to_s,
-          'margin-top' => MARGINS_TOP[tag].to_s
-        }
+        <<~STYLES
+          font-size: #{SIZES[tag]}px;
+          font-weight: bold;
+          margin-bottom: #{MARGINS_BOTTOM[tag]}px;
+          margin-top: #{MARGINS_TOP[tag]}px;
+        STYLES
       end
     end
   end