prawn-html 0.5.0 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e82e0a464e39fd4c47c399cb043ceefe090524b29ead1c06795a484d4c648388
-  data.tar.gz: e124a7fb9800a434f42d403b478c6a6cb30b4e7d1e7e540d015028dec6daaa59
+  metadata.gz: c773502449714d4f0a6f2401721ba67a349731ef9f0c525216864b355fbe76c8
+  data.tar.gz: 8857a7761f343367a4c6496757c767b6b62b46d0d840df96a7d545c3693c744f
 SHA512:
-  metadata.gz: c08e1252e2c9c8f1591840179549d3e14483d91361b1a9f56d96f23cfa30829b98d8d2ace33808a73a9467e1ff37054d7f462d1c7170db273a4ff83b203d807f
-  data.tar.gz: '0979bd9a66e463ee8e4ea3c141a2d4e2fcc0e3b1bc82397aeda2e357c10c4518b00b1e1e4fc3f2ec786070c6d229241423cd5933a89fbc9137bdccc211d22a44'
+  metadata.gz: 51be5bfbbf4427f6124a4a00cfb399017d6b806d8d3d2bb228fc81b7547a3cbaffe535767c5270a2666bed0a9abd89099d156dd79b1ea638d39101e528207be0
+  data.tar.gz: 520221561fc067919e098349fe6fab940290f6de419b37722679eacbb959055700620539c067d6a57786e7d4396bd0a4659e0f95428b09a96c3a93c55e174bda

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):
 
@@ -90,6 +92,8 @@ CSS attributes (dimensional units are ignored and considered in pixel):
 - **top**: see *position (absolute)*
 - **width**: for *img* tag, support also percentage, ex. `<img src="image.jpg" style="width: 50%; height: 200px"/>`
 
+The above attributes supports the `initial` value to reset them to their original value.
+
 For colors, the supported formats are:
 - 3 hex digits, ex. `color: #FB1`;
 - 6 hex digits, ex. `color: #abcdef`;

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

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require 'ostruct'
+require 'set'
 
 module PrawnHtml
   class Attributes < OpenStruct
-    attr_reader :styles
+    attr_reader :initial, :styles
 
     STYLES_APPLY = {
       block: %i[align bottom leading left margin_left padding_left position right top],
@@ -19,13 +20,13 @@ 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_styles },
-      'font-weight' => { key: :styles, set: :append_styles },
+      'font-style' => { key: :styles, set: :append_styles, values: %i[italic] },
+      'font-weight' => { key: :styles, set: :append_styles, values: %i[bold] },
       '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_text_decoration },
-      'vertical-align' => { key: :styles, set: :append_styles },
+      'text-decoration' => { key: :styles, set: :append_styles, values: %i[underline] },
+      'vertical-align' => { key: :styles, set: :append_styles, values: %i[subscript superscript] },
       'white-space' => { key: :white_space, set: :convert_symbol },
       # tag opening styles
       'break-before' => { key: :break_before, set: :convert_symbol },
@@ -44,7 +45,9 @@ module PrawnHtml
       'position' => { key: :position, set: :convert_symbol },
       'right' => { key: :right, set: :convert_size, options: :width },
       'text-align' => { key: :align, set: :convert_symbol },
-      'top' => { key: :top, set: :convert_size, options: :height }
+      'top' => { key: :top, set: :convert_size, options: :height },
+      # special styles
+      'text-decoration-line-through' => { key: :callback, set: :callback_strike_through }
     }.freeze
 
     STYLES_MERGE = %i[margin_left padding_left].freeze
@@ -53,6 +56,7 @@ module PrawnHtml
     def initialize(attributes = {})
       super
       @styles = {} # result styles
+      @initial = Set.new
     end
 
     # Processes the data attributes
@@ -74,6 +78,33 @@ module PrawnHtml
       process_styles(hash_styles, options: options) unless hash_styles.empty?
     end
 
+    # Remove an attribute value from the context styles
+    #
+    # @param context_styles [Hash] hash of the context styles that will be updated
+    # @param rule [Hash] rule from the STYLES_LIST to lookup in the context style for value removal
+    def remove_value(context_styles, rule)
+      if rule[:set] == :append_styles
+        context_styles[rule[:key]] -= rule[:values] if context_styles[:styles]
+      else
+        default = Context::DEFAULT_STYLES[rule[:key]]
+        default ? (context_styles[rule[:key]] = default) : context_styles.delete(rule[:key])
+      end
+    end
+
+    # Update context styles applying the initial rules (if set)
+    #
+    # @param context_styles [Hash] hash of the context styles that will be updated
+    #
+    # @return [Hash] the update context styles
+    def update_styles(context_styles)
+      initial.each do |rule|
+        next unless rule
+
+        remove_value(context_styles, rule)
+      end
+      context_styles
+    end
+
     class << self
       # Merges attributes
       #
@@ -105,29 +136,30 @@ module PrawnHtml
     def process_styles(hash_styles, options:)
       hash_styles.each do |key, value|
         rule = evaluate_rule(key, value)
+        next unless rule
+
         apply_rule!(merged_styles: @styles, rule: rule, value: value, options: options)
       end
       @styles
     end
 
     def evaluate_rule(rule_key, attr_value)
-      rule = STYLES_LIST[rule_key]
-      if rule && rule[:set] == :append_text_decoration
-        return { key: :callback, set: :callback_strike_through } if attr_value == 'line-through'
-
-        return { key: :styles, set: :append_styles }
-      end
-      rule
+      key = nil
+      key = 'text-decoration-line-through' if rule_key == 'text-decoration' && attr_value == 'line-through'
+      key ||= rule_key
+      STYLES_LIST[key]
     end
 
     def apply_rule!(merged_styles:, rule:, value:, options:)
-      return unless rule
+      return (@initial << rule) if value == 'initial'
 
       if rule[:set] == :append_styles
-        (merged_styles[rule[:key]] ||= []) << 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
-        merged_styles[rule[:key]] = Utils.send(rule[:set], value, options: opts)
+        val = Utils.send(rule[:set], value, options: opts)
+        merged_styles[rule[:key]] = val if val
       end
     end
   end

data/lib/prawn_html/context.rb

@@ -2,7 +2,9 @@
 
 module PrawnHtml
   class Context < Array
-    DEF_FONT_SIZE = 16 * PX
+    DEFAULT_STYLES = {
+      size: 16 * PX
+    }.freeze
 
     attr_reader :previous_tag
     attr_accessor :last_text_node
@@ -54,9 +56,9 @@ module PrawnHtml
     # @return [Hash] the hash of merged styles
     def merged_styles
       @merged_styles ||=
-        each_with_object(base_styles) do |element, res|
+        each_with_object(DEFAULT_STYLES.dup) do |element, res|
           evaluate_element_styles(element, res)
-          element.update_styles(res) if element.respond_to?(:update_styles)
+          element.update_styles(res)
         end
     end
 
@@ -65,18 +67,19 @@ module PrawnHtml
       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
 
-    private
-
-    def base_styles
-      {
-        size: DEF_FONT_SIZE
-      }
+    # 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)
       styles = element.styles.slice(*Attributes::STYLES_APPLY[:text_node])
       styles.each do |key, val|

data/lib/prawn_html/document_renderer.rb

@@ -12,6 +12,8 @@ module PrawnHtml
       @buffer = []
       @context = Context.new
       @last_margin = 0
+      @last_text = ''
+      @last_tag_open = false
       @pdf = pdf
     end
 
@@ -22,6 +24,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 +42,7 @@ 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)
+        @last_tag_open = true
       end
     end
 
@@ -47,9 +52,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 +76,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 +106,13 @@ 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
+      before_content = context.before_content
+      text = before_content ? ::Oga::HTML::Entities.decode(before_content) : ''
+      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 +134,10 @@ module PrawnHtml
     def adjust_leading(buffer, leading)
       return leading if leading
 
-      (buffer.map { |item| item[:size] || Context::DEF_FONT_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/tag.rb

@@ -2,12 +2,17 @@
 
 module PrawnHtml
   class Tag
+    extend Forwardable
+
     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
 
+    def_delegators :@attrs, :styles, :update_styles
+
     attr_accessor :parent
     attr_reader :attrs, :tag
 
@@ -45,6 +50,7 @@ module PrawnHtml
       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)
+      attrs.merge_text_styles!(extra_styles, options: options) if respond_to?(:extra_styles)
     end
 
     # Styles to apply on tag closing
@@ -54,13 +60,6 @@ module PrawnHtml
       styles.slice(*Attributes::STYLES_APPLY[:tag_close])
     end
 
-    # Styles hash
-    #
-    # @return [Hash] hash of styles
-    def styles
-      attrs.styles
-    end
-
     # Styles to apply on tag opening
     #
     # @return [Hash] hash of styles to apply

data/lib/prawn_html/tags/a.rb

@@ -5,12 +5,13 @@ module PrawnHtml
     class A < Tag
       ELEMENTS = [:a].freeze
 
-      def tag_styles
-        return unless attrs.href
+      def extra_styles
+        attrs.href ? "href: #{attrs.href}" : nil
+      end
 
+      def tag_styles
         <<~STYLES
           color: #00E;
-          href: #{attrs.href};
           text-decoration: underline;
         STYLES
       end

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/tags/small.rb

@@ -5,10 +5,10 @@ module PrawnHtml
     class Small < Tag
       ELEMENTS = [:small].freeze
 
-      def update_styles(styles)
-        size = (styles[:size] || Context::DEF_FONT_SIZE) * 0.85
-        styles[:size] = size
-        styles
+      def update_styles(context_styles)
+        size = (context_styles[:size] || Context::DEFAULT_STYLES[:size]) * 0.85
+        context_styles[:size] = size
+        super(context_styles)
       end
     end
   end

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.5.0'
+  VERSION = '0.6.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-html
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.4
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2022-05-03 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