prawn-markup 0.1.0

data/lib/prawn/markup/processor/tables.rb

@@ -0,0 +1,97 @@
+module Prawn
+  module Markup
+    module Processor::Tables
+      def self.prepended(base)
+        base.known_elements.push('table', 'tr', 'td', 'th')
+      end
+
+      def start_table
+        if current_table
+          add_cell_text_node(current_cell)
+        else
+          add_current_text
+        end
+        table_stack.push([])
+      end
+
+      def end_table
+        data = table_stack.pop
+        return if data.empty? || data.all?(&:empty?)
+
+        if table_stack.empty?
+          add_table(data)
+        else
+          current_cell.nodes << data
+        end
+      end
+
+      def start_tr
+        current_table << []
+      end
+
+      def start_td
+        current_table.last << Elements::Cell.new(width: style_properties['width'])
+      end
+
+      def start_th
+        current_table.last << Elements::Cell.new(width: style_properties['width'], header: true)
+      end
+
+      def end_td
+        add_cell_text_node(current_cell)
+      end
+      alias end_th end_td
+
+      def start_img
+        if current_table
+          add_cell_image(current_cell)
+        else
+          super
+        end
+      end
+
+      private
+
+      attr_reader :table_stack
+
+      def reset
+        @table_stack = []
+        super
+      end
+
+      def current_table
+        table_stack.last
+      end
+
+      def current_cell
+        current_table.last.last
+      end
+
+      def inside_container?
+        super || current_table
+      end
+
+      def add_cell_text_node(cell, options = {})
+        return unless buffered_text?
+        cell.nodes << options.merge(content: dump_text.strip)
+      end
+
+      def add_cell_image(cell)
+        add_cell_text_node(cell)
+        img = image_properties(current_attrs['src'])
+        cell.nodes << img || invalid_image_placeholder
+      end
+
+      def add_table(cells)
+        Builders::TableBuilder.new(pdf, cells, pdf.bounds.width, options).draw
+        put_bottom_margin(text_margin_bottom)
+      rescue Prawn::Errors::CannotFit => e
+        append_text(table_too_large_placeholder(e))
+      end
+
+      def table_too_large_placeholder(error)
+        placeholder_value(%i[table placeholder too_large], error) || '[table content too large]'
+      end
+    end
+  end
+end

data/lib/prawn/markup/processor/text.rb

@@ -0,0 +1,176 @@
+module Prawn
+  module Markup
+    module Processor::Text
+      def self.prepended(base)
+        base.known_elements.push('p', 'br', 'div', 'b', 'strong', 'i', 'em', 'u', 'a', 'hr')
+      end
+
+      def start_br
+        append_text("\n")
+      end
+
+      def start_p
+        handle_text_element
+      end
+
+      def end_p
+        if inside_container?
+          append_new_line
+          append_text("\n")
+        else
+          add_paragraph
+        end
+      end
+
+      def start_div
+        handle_text_element
+      end
+
+      def end_div
+        handle_text_element
+      end
+
+      def start_a
+        append_text("<link href=\"#{current_attrs['href']}\">")
+      end
+
+      def end_a
+        append_text('</link>')
+      end
+
+      def start_b
+        append_text('<b>')
+      end
+      alias start_strong start_b
+
+      def end_b
+        append_text('</b>')
+      end
+      alias end_strong end_b
+
+      def start_i
+        append_text('<i>')
+      end
+      alias start_em start_i
+
+      def end_i
+        append_text('</i>')
+      end
+      alias end_em end_i
+
+      def start_hr
+        return if inside_container?
+
+        put_bottom_margin(nil)
+        add_current_text
+        pdf.move_down(hr_vertical_margin_top)
+        pdf.stroke_horizontal_rule
+        pdf.move_down(hr_vertical_margin_bottom)
+      end
+
+      def end_document
+        add_current_text
+      end
+
+      private
+
+      def handle_text_element
+        if inside_container?
+          append_new_line
+        else
+          add_current_text
+        end
+      end
+
+      def append_new_line
+        append_text("\n") if buffered_text? && text_buffer[-1] != "\n"
+      end
+
+      def add_paragraph
+        text = dump_text
+        text.gsub!(/[^\n]/, '') if text.strip.empty?
+        unless text.empty?
+          add_bottom_margin
+          add_formatted_text(text, text_options)
+          put_bottom_margin(text_margin_bottom)
+        end
+      end
+
+      def add_current_text(options = text_options)
+        add_bottom_margin
+        return unless buffered_text?
+
+        string = dump_text
+        string.strip!
+        add_formatted_text(string, options)
+      end
+
+      def add_bottom_margin
+        if @bottom_margin
+          pdf.move_down(@bottom_margin)
+          @bottom_margin = nil
+        end
+      end
+
+      def add_formatted_text(string, options = text_options)
+        with_font(options) do
+          pdf.text(string, options)
+        end
+      end
+
+      def with_font(options)
+        pdf.font(options[:font] || pdf.font.family,
+                 size: options[:size],
+                 style: options[:style]) do
+          return yield
+        end
+      end
+
+      def hr_vertical_margin_top
+        @hr_vertical_margin_top ||=
+          (text_options[:size] || pdf.font_size) / 2.0
+      end
+
+      def hr_vertical_margin_bottom
+        @hr_vertical_margin_bottom ||= with_font(text_options) do
+          hr_vertical_margin_top +
+            pdf.font.descender +
+            text_leading -
+            pdf.line_width
+        end
+      end
+
+      def reset
+        super
+        text_margin_bottom # pre-calculate
+      end
+
+      def text_margin_bottom
+        options[:text] ||= {}
+        options[:text][:margin_bottom] ||= default_text_margin_bottom
+      end
+
+      def default_text_margin_bottom
+        with_font(text_options) do
+          pdf.font.line_gap +
+            pdf.font.descender +
+            text_leading
+        end
+      end
+
+      def text_leading
+        text_options[:leading] || pdf.default_leading
+      end
+
+      def text_options
+        @text_options ||= HashMerger.deep(default_text_options, options[:text] || {})
+      end
+
+      def default_text_options
+        {
+          inline_format: true
+        }
+      end
+    end
+  end
+end

data/lib/prawn/markup/support/hash_merger.rb

@@ -0,0 +1,19 @@
+module Prawn
+  module Markup
+    module HashMerger
+      def self.deep(hash, other)
+        hash.merge(other) do |_key, this_val, other_val|
+          if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+            deep(this_val, other_val)
+          else
+            other_val
+          end
+        end
+      end
+
+      def self.enhance(options, key, hash)
+        options[key] = hash.merge(options[key])
+      end
+    end
+  end
+end

data/lib/prawn/markup/support/normalizer.rb

@@ -0,0 +1,48 @@
+module Prawn
+  module Markup
+    # Normalizes HTML markup:
+    #  * assert that self-closing tags are always closed
+    #  * replace html entities with their UTF-8 correspondent string
+    #  * normalize white space
+    #  * wrap entire content into <root> tag
+    class Normalizer
+      SELF_CLOSING_ELEMENTS = %w[br img hr].freeze
+
+      REPLACE_ENTITIES = {
+        nbsp: ' '
+      }.freeze
+
+      attr_reader :html
+
+      def initialize(html)
+        @html = html.dup
+      end
+
+      def normalize
+        close_self_closing_elements
+        normalize_spaces
+        replace_html_entities
+        "<root>#{html}</root>"
+      end
+
+      private
+
+      def close_self_closing_elements
+        html.gsub!(/<(#{SELF_CLOSING_ELEMENTS.join('|')})[^>]*>/i) do |tag|
+          tag[-1] = '/>' unless tag.end_with?('/>')
+          tag
+        end
+      end
+
+      def normalize_spaces
+        html.gsub!(/\s+/, ' ')
+      end
+
+      def replace_html_entities
+        REPLACE_ENTITIES.each do |entity, string|
+          html.gsub!(/&#{entity};/, string)
+        end
+      end
+    end
+  end
+end

data/lib/prawn/markup/support/size_converter.rb

@@ -0,0 +1,31 @@
+module Prawn
+  module Markup
+    class SizeConverter
+      attr_reader :max
+
+      def initialize(max)
+        @max = max
+      end
+
+      def parse(width)
+        return nil if width.to_s.strip.empty? || width.to_s == 'auto'
+
+        points = convert(width)
+        max ? [points, max].min : points
+      end
+
+      def convert(string)
+        value = string.to_f
+        if string.end_with?('%')
+          value * max / 100.0
+        elsif string.end_with?('cm')
+          value.cm
+        elsif string.end_with?('mm')
+          value.mm
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/prawn/markup/version.rb

@@ -0,0 +1,5 @@
+module Prawn
+  module Markup
+    VERSION = '0.1.0'.freeze
+  end
+end

data/prawn-markup.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prawn/markup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prawn-markup'
+  spec.version       = Prawn::Markup::VERSION
+  spec.authors       = ['Pascal Zumkehr']
+  spec.email         = ['zumkehr@puzzle.ch']
+
+  spec.summary       = 'Parse simple HTML markup to include in Prawn PDFs'
+  spec.description   = 'Adds simple HTML snippets into Prawn-generated PDFs. ' \
+                       'All elements are layouted vertically using Prawn\'s formatting ' \
+                       'options. A major use case for this gem is to include ' \
+                       'WYSIWYG-generated HTML parts into server-generated PDF documents.'
+  spec.homepage      = 'https://github.com/puzzle/prawn-markup'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'prawn'
+  spec.add_dependency 'prawn-table'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'pdf-inspector'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: prawn-markup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pascal Zumkehr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prawn-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pdf-inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds simple HTML snippets into Prawn-generated PDFs. All elements are
+  layouted vertically using Prawn's formatting options. A major use case for this
+  gem is to include WYSIWYG-generated HTML parts into server-generated PDF documents.
+email:
+- zumkehr@puzzle.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/prawn/markup.rb
+- lib/prawn/markup/builders/list_builder.rb
+- lib/prawn/markup/builders/nestable_builder.rb
+- lib/prawn/markup/builders/table_builder.rb
+- lib/prawn/markup/elements/cell.rb
+- lib/prawn/markup/elements/item.rb
+- lib/prawn/markup/elements/list.rb
+- lib/prawn/markup/interface.rb
+- lib/prawn/markup/processor.rb
+- lib/prawn/markup/processor/headings.rb
+- lib/prawn/markup/processor/images.rb
+- lib/prawn/markup/processor/lists.rb
+- lib/prawn/markup/processor/tables.rb
+- lib/prawn/markup/processor/text.rb
+- lib/prawn/markup/support/hash_merger.rb
+- lib/prawn/markup/support/normalizer.rb
+- lib/prawn/markup/support/size_converter.rb
+- lib/prawn/markup/version.rb
+- prawn-markup.gemspec
+homepage: https://github.com/puzzle/prawn-markup
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Parse simple HTML markup to include in Prawn PDFs
+test_files: []