prawn-html 0.6.0 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b659b809526c4c961782f613e6946613232dd836ac056ca48d3dabebdbf9a02
-  data.tar.gz: 2549b8b8b872b44f3d6f424236249e7795f97afeadf95299bf06836fb979a13a
+  metadata.gz: 4593c000107eaa95af317e336d16e34a7cfcffadef95e736eedaebce1c1723f0
+  data.tar.gz: da05881be31d5a4058b41176336d72cd1c1e190a1a1fd59b36f671f6a7e5c98e
 SHA512:
-  metadata.gz: b58a21e4424c89db5ff388ab2507ec502ea283ba9e6234d46f3688e477ba21944ee72f813cc9ddb4454426f5e4cc7397531ffa34c74eeb7795a0bbbeaa8d34ed
-  data.tar.gz: 0e3cfad427968577135c8c8791f698b3c5d6e95463b9364d0630d9caf87407f378c3fb725bfe11349cad210d1d0c3bba1a90555ebb9219c620e674fff0413ff8
+  metadata.gz: a8061299f670a1b0f895ac521e4bb6f242125830152bd3eaccb0c33dee3d6aaa1ad2ad179197a2d1ad3cb9aad28fe38aefdc18db1fd55d4148f7870e5b68038a
+  data.tar.gz: ab1e8d1c552f6d105ddd9ffbd565b3d1f816857d48649b5dbc89e18495e4257175d0047a7dea1be1974b26ee81e085254c37e9aa84b0da253667a159ea772bda

data/README.md

@@ -1,5 +1,7 @@
 # Prawn HTML
 [![gem version](https://badge.fury.io/rb/prawn-html.svg)](https://rubygems.org/gems/prawn-html)
+[![gem downloads](https://badgen.net/rubygems/dt/prawn-html)](https://rubygems.org/gems/prawn-html)
+[![maintainability](https://api.codeclimate.com/v1/badges/db674db00817d56ca1e9/maintainability)](https://codeclimate.com/github/blocknotes/prawn-html/maintainability)
 [![linters](https://github.com/blocknotes/prawn-html/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/prawn-html/actions/workflows/linters.yml)
 [![specs](https://github.com/blocknotes/prawn-html/actions/workflows/specs.yml/badge.svg)](https://github.com/blocknotes/prawn-html/actions/workflows/specs.yml)
 
@@ -35,34 +37,34 @@ To check some examples with the PDF output see [examples](examples/) folder.
 
 ## Supported tags & attributes
 
-HTML tags:
-
-- **a**: link
-- **b**: bold
-- **blockquote**: block quotation element
-- **br**: new line
-- **code**: inline code element
-- **del**: strike-through
-- **div**: block element
-- **em**: italic
-- **h1** - **h6**: headings
-- **hr**: horizontal line
-- **i**: italic
-- **ins**: underline
-- **img**: image
-- **li**: list item
-- **mark**: highlight
-- **ol**: ordered list
-- **p**: block element
-- **pre**: preformatted text element
-- **s**: strike-through
-- **small**: smaller text
-- **span**: inline element
-- **strong**: bold
-- **sub**: subscript element
-- **sup**: superscript element
-- **u**: underline
-- **ul**: unordered list
+HTML tags (using MDN definitions):
+
+- **a**: the Anchor element
+- **b**: the Bring Attention To element
+- **blockquote**: the Block Quotation element
+- **br**: the Line Break element
+- **code**: the Inline Code element
+- **del**: the Deleted Text element
+- **div**: the Content Division element
+- **em**: the Emphasis element
+- **h1** - **h6**: the HTML Section Heading elements
+- **hr**: the Thematic Break (Horizontal Rule) element
+- **i**: the Idiomatic Text element
+- **ins**: the added text element
+- **img**: the Image Embed element
+- **li**: the list item element
+- **mark**: the Mark Text element
+- **ol**: the Ordered List element
+- **p**: the Paragraph element
+- **pre**: the Preformatted Text element
+- **s**: the strike-through text element
+- **small**: the side comment element
+- **span**: the generic inline element
+- **strong**: the Strong Importance element
+- **sub**: the Subscript element
+- **sup**: the Superscript element
+- **u**: the Unarticulated Annotation (Underline) element
+- **ul**: the Unordered List element
 
 CSS attributes (dimensional units are ignored and considered in pixel):
 

data/lib/prawn-html.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module PrawnHtml
+  ADJUST_LEADING = { nil => 0.18, 'Courier' => -0.07, 'Helvetica' => -0.17, 'Times-Roman' => 0.03 }.freeze
   PX = 0.6 # conversion constant for pixel sixes
 
   COLORS = {

data/lib/prawn_html/attributes.rb

@@ -154,7 +154,7 @@ module PrawnHtml
       return (@initial << rule) if value == 'initial'
 
       if rule[:set] == :append_styles
-        val = Utils.normalize_style(value)
+        val = Utils.normalize_style(value, rule[:values])
         (merged_styles[rule[:key]] ||= []) << val if val
       else
         opts = rule[:options] ? options[rule[:options]] : nil

data/lib/prawn_html/context.rb

@@ -62,15 +62,28 @@ module PrawnHtml
         end
     end
 
+    # :nocov:
+    def inspect
+      map(&:class).map(&:to_s).join(', ')
+    end
+    # :nocov:
+
     # Remove the last element from the context
     def remove_last
       last.on_context_remove(self) if last.respond_to?(:on_context_remove)
       @merged_styles = nil
       @last_text_node = false
-      @previous_tag = last.tag
+      @previous_tag = last
       pop
     end
 
+    # White space is equal to 'pre'?
+    #
+    # @return [boolean] white space property of the last element is equal to 'pre'
+    def white_space_pre?
+      last && last.styles[:white_space] == :pre
+    end
+
     private
 
     def evaluate_element_styles(element, res)

data/lib/prawn_html/document_renderer.rb

@@ -9,9 +9,12 @@ module PrawnHtml
     #
     # @param pdf [PdfWrapper] target PDF wrapper
     def initialize(pdf)
+      @before_content = []
       @buffer = []
       @context = Context.new
       @last_margin = 0
+      @last_text = ''
+      @last_tag_open = false
       @pdf = pdf
     end
 
@@ -22,6 +25,8 @@ module PrawnHtml
       render_if_needed(element)
       apply_tag_close_styles(element)
       context.remove_last
+      @last_tag_open = false
+      @last_text = ''
     end
 
     # On tag open callback
@@ -38,6 +43,8 @@ module PrawnHtml
       options = { width: pdf.page_width, height: pdf.page_height }
       tag_class.new(tag_name, attributes: attributes, options: options).tap do |element|
         setup_element(element, element_styles: element_styles)
+        @before_content.push(element.before_content) if element.respond_to?(:before_content)
+        @last_tag_open = true
       end
     end
 
@@ -47,9 +54,10 @@ module PrawnHtml
     #
     # @return [NilClass] nil value (=> no element)
     def on_text_node(content)
-      return if content.match?(/\A\s*\Z/)
+      return if context.previous_tag&.block? && content.match?(/\A\s*\Z/)
 
-      buffer << context.merged_styles.merge(text: prepare_text(content))
+      text = prepare_text(content)
+      buffer << context.merged_styles.merge(text: text) unless text.empty?
       context.last_text_node = true
       nil
     end
@@ -70,17 +78,13 @@ module PrawnHtml
     attr_reader :buffer, :context, :last_margin, :pdf
 
     def setup_element(element, element_styles:)
-      add_space_if_needed unless render_if_needed(element)
+      render_if_needed(element)
       context.add(element)
       element.process_styles(element_styles: element_styles)
       apply_tag_open_styles(element)
       element.custom_render(pdf, context) if element.respond_to?(:custom_render)
     end
 
-    def add_space_if_needed
-      buffer << SPACE if buffer.any? && !context.last_text_node && ![NEW_LINE, SPACE].include?(buffer.last)
-    end
-
     def render_if_needed(element)
       render_needed = element&.block? && buffer.any? && buffer.last != NEW_LINE
       return false unless render_needed
@@ -104,10 +108,14 @@ module PrawnHtml
     end
 
     def prepare_text(content)
-      white_space_pre = context.last && context.last.styles[:white_space] == :pre
-      text = ::Oga::HTML::Entities.decode(context.before_content)
-      text += white_space_pre ? content : content.gsub(/\A\s*\n\s*|\s*\n\s*\Z/, '').delete("\n").squeeze(' ')
-      text
+      text = @before_content.any? ? ::Oga::HTML::Entities.decode(@before_content.join) : ''
+      @before_content.clear
+
+      return (@last_text = text + content) if context.white_space_pre?
+
+      content = content.lstrip if @last_text[-1] == ' ' || @last_tag_open
+      text += content.tr("\n", ' ').squeeze(' ')
+      @last_text = text
     end
 
     def output_content(buffer, block_styles)
@@ -129,7 +137,10 @@ module PrawnHtml
     def adjust_leading(buffer, leading)
       return leading if leading
 
-      (buffer.map { |item| item[:size] || Context::DEFAULT_STYLES[:size] }.max * 0.055).round(4)
+      leadings = buffer.map do |item|
+        (item[:size] || Context::DEFAULT_STYLES[:size]) * (ADJUST_LEADING[item[:font]] || ADJUST_LEADING[nil])
+      end
+      leadings.max.round(4)
     end
 
     def bounds(buffer, options, block_styles)

data/lib/prawn_html/tags/br.rb

@@ -12,7 +12,7 @@ module PrawnHtml
       end
 
       def custom_render(pdf, context)
-        return if context.last_text_node || context.previous_tag != :br
+        return if context.last_text_node || !context.previous_tag.is_a?(Br)
 
         pdf.advance_cursor(BR_SPACING)
       end

data/lib/prawn_html/tags/li.rb

@@ -13,7 +13,9 @@ module PrawnHtml
       end
 
       def before_content
-        @counter ? "#{@counter}. " : "#{@symbol} "
+        return if @before_content_once
+
+        @before_content_once = @counter ? "#{@counter}. " : "#{@symbol} "
       end
 
       def block_styles

data/lib/prawn_html/utils.rb

@@ -45,7 +45,7 @@ module PrawnHtml
 
       if val.match /\A#([a-f0-9]{3})\Z/ # rubocop:disable Performance/RedundantMatch
         r, g, b = Regexp.last_match[1].chars
-        return r * 2 + g * 2 + b * 2
+        return (r * 2) + (g * 2) + (b * 2)
       end
       if val.match /\Argb\s*\(\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*\)\Z/ # rubocop:disable Performance/RedundantMatch
         r, g, b = Regexp.last_match[1..3].map { |v| v.to_i.to_s(16) }
@@ -103,11 +103,13 @@ module PrawnHtml
     # Normalize a style value
     #
     # @param value [String] string value
+    # @param accepted_values [Array] allowlist of valid values (symbols)
     #
     # @return [Symbol] style value or nil
-    def normalize_style(value)
+    def normalize_style(value, accepted_values)
       val = value&.strip&.downcase
-      NORMALIZE_STYLES[val]
+      ret = NORMALIZE_STYLES[val]
+      accepted_values.include?(ret) ? ret : nil
     end
 
     # Unquotes a string

data/lib/prawn_html/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-html
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.5
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oga
@@ -83,7 +83,10 @@ files:
 homepage: https://github.com/blocknotes/prawn-html
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/blocknotes/prawn-html
+  source_code_uri: https://github.com/blocknotes/prawn-html
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -99,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Prawn PDF - HTML renderer