RubyGems - prawn-html - Versions diffs - 0.3.2 → 0.4.0 - Mend

prawn-html 0.3.2 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

checksums.yaml +4 -4
data/README.md +2 -2
data/lib/prawn-html.rb +2 -1
data/lib/prawn_html/attributes.rb +17 -23
data/lib/prawn_html/context.rb +1 -3
data/lib/prawn_html/document_renderer.rb +12 -16
data/lib/prawn_html/html_parser.rb +35 -10
data/lib/prawn_html/tag.rb +12 -22
data/lib/prawn_html/tags/a.rb +1 -1
data/lib/prawn_html/tags/b.rb +1 -3
data/lib/prawn_html/tags/blockquote.rb +25 -0
data/lib/prawn_html/tags/del.rb +1 -3
data/lib/prawn_html/tags/h.rb +6 -6
data/lib/prawn_html/tags/hr.rb +4 -4
data/lib/prawn_html/tags/i.rb +1 -3
data/lib/prawn_html/tags/li.rb +4 -6
data/lib/prawn_html/tags/mark.rb +1 -3
data/lib/prawn_html/tags/ol.rb +2 -4
data/lib/prawn_html/tags/p.rb +4 -4
data/lib/prawn_html/tags/u.rb +1 -3
data/lib/prawn_html/tags/ul.rb +1 -3
data/lib/prawn_html/utils.rb +18 -1
data/lib/prawn_html/version.rb +1 -1
metadata +3 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 998ac3f3429812cc60dfe2bdf0184a86c116b1b80c7522376f99e044f185207c
-  data.tar.gz: 1a4ce4f9055fa8dd8ed121665102698b6077d69986974c366098d69759555d80
+  metadata.gz: 4dec0bd9a3746705bdaca34d49c8a8eff5700fd8a5feebc3b3452001cd239b0b
+  data.tar.gz: 74b5e31d3056560435ea939f50f713f11c44ad4c1f584873203b910754e1f782
 SHA512:
-  metadata.gz: d443116a4be710f698f02da8092b19b0d83f9b319c0e7b431ae9cfe67d11c208ddea48ff5c995057bd3b28056dafcb2ff8461c1ad3be8134f9dcaa926b96ef73
-  data.tar.gz: 530a30ff700f75312a5f72b38ef433f9f03a3eab9ac9d83297a3eacc20d680df4ab1f8a4bc3c5134146b3da71be6ffa23d151bc71824dc21022fe7c5aa592758
+  metadata.gz: 814c481a5fce1da43dcb04254ed97f76f234fbdcaa6826070b00594f80cd3b4396c190a2972c0f6f72e00d35e5fd1b534cf22c9ef932b8ee308562de7c6bc854
+  data.tar.gz: f99ce1543d1b28689b19ceddd8e86a73fae8e204bc98270e6a422dd93e44d89ff50366969b67e0fb2a9a4e91d03367981ab5c0f9481b91378df57e2304358f40

data/README.md CHANGED Viewed

@@ -39,6 +39,7 @@ HTML tags:
 - **a**: link
 - **b**: bold
+- **blockquote**: block quotation element
 - **br**: new line
 - **del**: strike-through
 - **div**: block element
@@ -100,8 +101,7 @@ Some custom data attributes are used to pass options:
 ## Document styles
-[Experimental feature] You can define document CSS rules inside an _head_ tag, but with a limited support for now.
-Only single CSS selectors and basic ones are supported. Example:
+You can define document CSS rules inside an _head_ tag. Example:
 ```html
 <!DOCTYPE html>

data/lib/prawn-html.rb CHANGED Viewed

@@ -168,9 +168,10 @@ require 'prawn'
 require 'prawn_html/utils'
+Dir["#{__dir__}/prawn_html/callbacks/*.rb"].sort.each { |f| require f }
 require 'prawn_html/tag'
 Dir["#{__dir__}/prawn_html/tags/*.rb"].sort.each { |f| require f }
-Dir["#{__dir__}/prawn_html/callbacks/*.rb"].sort.each { |f| require f }
 require 'prawn_html/attributes'
 require 'prawn_html/context'

data/lib/prawn_html/attributes.rb CHANGED Viewed

@@ -20,12 +20,12 @@ module PrawnHtml
       'color' => { key: :color, set: :convert_color },
       'font-family' => { key: :font, set: :unquote },
       'font-size' => { key: :size, set: :convert_size },
-      'font-style' => { key: :styles, set: :append_symbol },
-      'font-weight' => { key: :styles, set: :append_symbol },
+      'font-style' => { key: :styles, set: :append_styles },
+      'font-weight' => { key: :styles, set: :append_styles },
       'href' => { key: :link, set: :copy_value },
       'letter-spacing' => { key: :character_spacing, set: :convert_float },
       'list-style-type' => { key: :list_style_type, set: :unquote },
-      'text-decoration' => { key: :styles, set: :append_symbol },
+      'text-decoration' => { key: :styles, set: :append_styles },
       # tag opening styles
       'break-before' => { key: :break_before, set: :convert_symbol },
       'margin-top' => { key: :margin_top, set: :convert_size },
@@ -50,10 +50,6 @@ module PrawnHtml
     def initialize(attributes = {})
       super
       @styles = {} # result styles
-      return unless style
-      styles_hash = Attributes.parse_styles(style)
-      process_styles(styles_hash)
     end
     # Processes the data attributes
@@ -66,21 +62,12 @@ module PrawnHtml
       end
     end
-    # Merge already parsed styles
-    #
-    # @param parsed_styles [Hash] hash of parsed styles
-    def merge_styles!(parsed_styles)
-      @styles.merge!(parsed_styles)
-    end
-    # Processes the styles attributes
+    # Merge text styles
     #
-    # @param styles_hash [Hash] hash of styles attributes
-    def process_styles(styles_hash)
-      styles_hash.each do |key, value|
-        apply_rule!(@styles, STYLES_LIST[key], value)
-      end
-      @styles
+    # @param text_styles [String] styles to parse and process
+    def merge_text_styles!(text_styles)
+      hash_styles = Attributes.parse_styles(text_styles)
+      process_styles(hash_styles) unless hash_styles.empty?
     end
     class << self
@@ -114,11 +101,18 @@ module PrawnHtml
     def apply_rule!(result, rule, value)
       return unless rule
-      if rule[:set] == :append_symbol
-        (result[rule[:key]] ||= []) << Utils.convert_symbol(value)
+      if rule[:set] == :append_styles
+        (result[rule[:key]] ||= []) << Utils.normalize_style(value)
       else
         result[rule[:key]] = Utils.send(rule[:set], value)
       end
     end
+    def process_styles(hash_styles)
+      hash_styles.each do |key, value|
+        apply_rule!(@styles, STYLES_LIST[key], value)
+      end
+      @styles
+    end
   end
 end

data/lib/prawn_html/context.rb CHANGED Viewed

@@ -32,9 +32,7 @@ module PrawnHtml
     #
     # @return [String] before content string
     def before_content
-      return '' if empty? || !last.respond_to?(:tag_styles)
-      last.tag_styles[:before_content].to_s
+      (last.respond_to?(:before_content) && last.before_content) || ''
     end
     # Merges the context block styles

data/lib/prawn_html/document_renderer.rb CHANGED Viewed

@@ -11,21 +11,9 @@ module PrawnHtml
     def initialize(pdf)
       @buffer = []
       @context = Context.new
-      @document_styles = {}
       @pdf = pdf
     end
-    # Evaluate the document styles and store the internally
-    #
-    # @param styles [Hash] styles hash with CSS selectors as keys and rules as values
-    def assign_document_styles(styles)
-      @document_styles.merge!(
-        styles.transform_values do |style_rules|
-          Attributes.new(style: style_rules).styles
-        end
-      )
-    end
     # On tag close callback
     #
     # @param element [Tag] closing element wrapper
@@ -40,13 +28,14 @@ module PrawnHtml
     #
     # @param tag_name [String] the tag name of the opening element
     # @param attributes [Hash] an hash of the element attributes
+    # @param element_styles [String] document styles to apply to the element
     #
     # @return [Tag] the opening element wrapper
-    def on_tag_open(tag_name, attributes)
+    def on_tag_open(tag_name, attributes:, element_styles: '')
       tag_class = Tag.class_for(tag_name)
       return unless tag_class
-      tag_class.new(tag_name, attributes, document_styles).tap do |element|
+      tag_class.new(tag_name, attributes: attributes, element_styles: element_styles).tap do |element|
         setup_element(element)
       end
     end
@@ -79,7 +68,7 @@ module PrawnHtml
     private
-    attr_reader :buffer, :context, :document_styles, :pdf
+    attr_reader :buffer, :context, :pdf
     def setup_element(element)
       add_space_if_needed unless render_if_needed(element)
@@ -115,13 +104,20 @@ module PrawnHtml
     end
     def output_content(buffer, block_styles)
-      buffer.each { |item| item[:callback] = item[:callback].new(pdf, item) if item[:callback] }
+      apply_callbacks(buffer)
       left_indent = block_styles[:margin_left].to_f + block_styles[:padding_left].to_f
       options = block_styles.slice(:align, :leading, :mode, :padding_left)
       options[:indent_paragraphs] = left_indent if left_indent > 0
       pdf.puts(buffer, options, bounding_box: bounds(block_styles))
     end
+    def apply_callbacks(buffer)
+      buffer.select { |item| item[:callback] }.each do |item|
+        callback = Tag::CALLBACKS[item[:callback]]
+        item[:callback] = callback.new(pdf, item)
+      end
+    end
     def bounds(block_styles)
       return unless block_styles[:position] == :absolute

data/lib/prawn_html/html_parser.rb CHANGED Viewed

@@ -4,12 +4,18 @@ require 'oga'
 module PrawnHtml
   class HtmlParser
+    REGEXP_STYLES = /\s*([^{\s]+)\s*{\s*([^}]*?)\s*}/m.freeze
     # Init the HtmlParser
     #
     # @param renderer [DocumentRenderer] document renderer
-    def initialize(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
+      @ignore = false
+      @ignore_content_tags = ignore_content_tags
       @renderer = renderer
+      @styles = {}
     end
     # Processes HTML and renders it
@@ -17,17 +23,19 @@ module PrawnHtml
     # @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/tag.rb CHANGED Viewed

@@ -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 = {
+      'Highlight' => Callbacks::Highlight,
+      'StrikeThrough' => Callbacks::StrikeThrough
+    }.freeze
+    TAG_CLASSES = %w[A B Blockquote Body Br Del Div H Hr I Img Li Mark Ol P Small Span 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 element_styles [String] document styles tp apply to the element
+    def initialize(tag, attributes: {}, element_styles: '')
       @tag = tag
-      element_styles = attributes.delete(:style)
       @attrs = Attributes.new(attributes)
-      process_styles(document_styles, element_styles)
+      process_styles(element_styles, attributes['style'])
     end
     # Is a block tag?
@@ -74,23 +77,10 @@ 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
+    def process_styles(element_styles, inline_styles)
+      attrs.merge_text_styles!(tag_styles) if respond_to?(:tag_styles)
+      attrs.merge_text_styles!(element_styles)
+      attrs.merge_text_styles!(inline_styles)
     end
   end
 end

data/lib/prawn_html/tags/a.rb CHANGED Viewed

@@ -6,7 +6,7 @@ module PrawnHtml
       ELEMENTS = [:a].freeze
       def tag_styles
-        attrs.href ? { 'href' => attrs.href } : {}
+        "href: #{attrs.href}" if attrs.href
       end
     end
   end

data/lib/prawn_html/tags/b.rb CHANGED Viewed

@@ -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 ADDED Viewed

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module PrawnHtml
+  module Tags
+    class Blockquote < Tag
+      ELEMENTS = [:blockquote].freeze
+      MARGIN_BOTTOM = 10
+      MARGIN_LEFT = 25
+      MARGIN_TOP = 10
+      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/del.rb CHANGED Viewed

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

data/lib/prawn_html/tags/h.rb CHANGED Viewed

@@ -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

data/lib/prawn_html/tags/hr.rb CHANGED Viewed

@@ -18,10 +18,10 @@ module PrawnHtml
       end
       def tag_styles
-        @tag_styles ||= {
-          'margin-bottom' => MARGIN_BOTTOM.to_s,
-          'margin-top' => MARGIN_TOP.to_s,
-        }
+        <<~STYLES
+          margin-bottom: #{MARGIN_BOTTOM}px;
+          margin-top: #{MARGIN_TOP}px;
+        STYLES
       end
       private

data/lib/prawn_html/tags/i.rb CHANGED Viewed

@@ -6,9 +6,7 @@ module PrawnHtml
       ELEMENTS = [:i, :em].freeze
       def tag_styles
-        {
-          'font-style' => 'italic'
-        }
+        'font-style: italic'
       end
     end
   end

data/lib/prawn_html/tags/li.rb CHANGED Viewed

@@ -9,16 +9,14 @@ module PrawnHtml
         true
       end
+      def before_content
+        @counter ? "#{@counter}. " : "#{@symbol} "
+      end
       def on_context_add(_context)
         @counter = (parent.counter += 1) if parent.is_a? Ol
         @symbol = parent.styles[:list_style_type] || '&bullet;' if parent.is_a? Ul
       end
-      def tag_styles
-        {
-          before_content: @counter ? "#{@counter}. " : "#{@symbol} "
-        }
-      end
     end
   end
 end

data/lib/prawn_html/tags/mark.rb CHANGED Viewed

@@ -6,9 +6,7 @@ module PrawnHtml
       ELEMENTS = [:mark].freeze
       def tag_styles
-        {
-          'callback' => Callbacks::Highlight
-        }
+        'callback: Highlight'
       end
     end
   end

data/lib/prawn_html/tags/ol.rb CHANGED Viewed

@@ -9,7 +9,7 @@ module PrawnHtml
       attr_accessor :counter
-      def initialize(*_args)
+      def initialize(tag, attributes: {}, element_styles: '')
         super
         @counter = 0
       end
@@ -19,9 +19,7 @@ module PrawnHtml
       end
       def tag_styles
-        @tag_styles ||= {
-          'margin-left' => MARGIN_LEFT.to_s,
-        }
+        "margin-left: #{MARGIN_LEFT}px"
       end
     end
   end

data/lib/prawn_html/tags/p.rb CHANGED Viewed

@@ -13,10 +13,10 @@ module PrawnHtml
       end
       def tag_styles
-        @tag_styles ||= {
-          'margin-bottom' => MARGIN_BOTTOM.to_s,
-          'margin-top' => MARGIN_TOP.to_s
-        }
+        <<~STYLES
+          margin-bottom: #{MARGIN_BOTTOM}px;
+          margin-top: #{MARGIN_TOP}px;
+        STYLES
       end
     end
   end

data/lib/prawn_html/tags/u.rb CHANGED Viewed

@@ -6,9 +6,7 @@ module PrawnHtml
       ELEMENTS = [:ins, :u].freeze
       def tag_styles
-        {
-          'text-decoration' => 'underline'
-        }
+        'text-decoration: underline'
       end
     end
   end

data/lib/prawn_html/tags/ul.rb CHANGED Viewed

@@ -12,9 +12,7 @@ module PrawnHtml
       end
       def tag_styles
-        @tag_styles ||= {
-          'margin-left' => MARGIN_LEFT.to_s,
-        }
+        "margin-left: #{MARGIN_LEFT}px"
       end
     end
   end

data/lib/prawn_html/utils.rb CHANGED Viewed

@@ -2,6 +2,12 @@
 module PrawnHtml
   module Utils
+    NORMALIZE_STYLES = {
+      'bold' => :bold,
+      'italic' => :italic,
+      'underline' => :underline
+    }.freeze
     # Converts a color string
     #
     # Supported formats:
@@ -74,6 +80,16 @@ module PrawnHtml
       value
     end
+    # Normalize a style value
+    #
+    # @param value [String] string value
+    #
+    # @return [Symbol] style value or nil
+    def normalize_style(value)
+      val = value&.strip&.downcase
+      NORMALIZE_STYLES[val]
+    end
     # Unquotes a string
     #
     # @param value [String] string
@@ -85,6 +101,7 @@ module PrawnHtml
       end
     end
-    module_function :convert_color, :convert_float, :convert_size, :convert_symbol, :copy_value, :unquote
+    module_function :convert_color, :convert_float, :convert_size, :convert_symbol, :copy_value, :normalize_style,
+                    :unquote
   end
 end

data/lib/prawn_html/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module PrawnHtml # :nodoc:
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-html
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-27 00:00:00.000000000 Z
+date: 2021-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oga
@@ -57,6 +57,7 @@ files:
 - lib/prawn_html/tag.rb
 - lib/prawn_html/tags/a.rb
 - lib/prawn_html/tags/b.rb
+- lib/prawn_html/tags/blockquote.rb
 - lib/prawn_html/tags/body.rb
 - lib/prawn_html/tags/br.rb
 - lib/prawn_html/tags/del.rb