prawn-styled-text 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32582ed8ed04afca6d934df3cc228df9dc283c00
+  data.tar.gz: bed3b3d2f987c821070473ce8e3dd9e6ae6f4419
+SHA512:
+  metadata.gz: d453360386385907f3a191baebfccd86bf2b05fa85c76bee76989099e1a370e663320c2ed62a5f5752915a3b61ceb983afce5c3168a96cbaf60a5a3ec63642f7
+  data.tar.gz: db20db2a101ec1ac0bf771670d84cdcb1786a8104562a25c04d86a0bcae6b5ed9a0b58a5e2be8d526fad378474b447f8dad33b7086ad34300eb3e2f1b4d6a394

data/.gitignore

@@ -0,0 +1,3 @@
+_misc/
+examples/*.pdf
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Mattia Roccoberton
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Prawn Styled Text [![Gem Version](https://badge.fury.io/rb/prawn-styled-text.svg)](https://badge.fury.io/rb/prawn-styled-text)
+
+A Prawn PDF component which adds basic HTML support.
+
+**Important**: render HTML documents is not an easy task; only a small set of tags and attributes are supported and complex layouts will not render correctly; if you look for real HTML to PDF convertion please try other gems like WickedPDF
+
+## Supported tags & attributes
+
+HTML tags:
+- a
+- b
+- br 
+- div
+- h1 - h6
+- hr
+- i
+- img
+- span
+- u
+- ul / li
+
+CSS attributes:
+- color (*only 6 hex digits format, # is ignored, ex. FFBB11*)
+- font-family
+- font-size (*units are ignored*)
+- font-style (*accepts list of values, ex. bold, italic*)
+- href (*tag a*)
+- letter-spacing
+- line-height (*as heading, units are ignored*)
+- margin-left (*units are ignored*)
+- margin-top (*units are ignored*)
+- src (*tag img*)
+- text-align
+
+## Examples
+
+See [examples](https://github.com/blocknotes/prawn-styled-text/tree/master/examples) folder.
+
+## Contributors
+
+- [Mattia Roccoberton](http://blocknot.es) - creator, maintainer
+
+## License
+
+[MIT](LICENSE.txt)

data/examples/basic.rb

@@ -0,0 +1,9 @@
+require 'prawn'
+require 'prawn-styled-text'
+require 'oga'
+
+Prawn::Font::AFM.hide_m17n_warning = true
+
+pdf = Prawn::Document.new
+pdf.styled_text File.read( 'test.html' )
+pdf.render_file 'test.pdf'

data/examples/columns.rb

@@ -0,0 +1,16 @@
+require 'prawn'
+require 'prawn-styled-text'
+require 'oga'
+
+html = <<~EOL
+  <div style="font-size: 16px; text-align: justify">Lorem ipsum dolor sit <b>amet</b>, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud <i>exercitation</i> ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in <u>reprehenderit</u> in voluptate velit esse cillum dolore eu fugiat nulla pariatur.<br/>Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+    <br/>
+  </div>
+EOL
+
+pdf = Prawn::Document.new
+pdf.styled_text '<h1 style="text-align: center">2 columns</h1>'
+pdf.column_box( [ 0, pdf.cursor ], columns: 2, width: pdf.bounds.width ) do
+  pdf.styled_text html * 4
+end
+pdf.render_file 'test.pdf'

data/examples/erb.rb

@@ -0,0 +1,13 @@
+require 'erb'
+require 'prawn'
+require 'prawn-styled-text'
+require 'oga'
+
+ERB_FILE = 'test.html.erb'
+
+Prawn::Font::AFM.hide_m17n_warning = true
+
+pdf = Prawn::Document.new
+pdf.text "\nA test document\n", align: :center, size: 18
+pdf.styled_text ERB.new( File.read( ERB_FILE ) ).result( binding )
+pdf.render_file 'test.pdf'

data/examples/grid.rb

@@ -0,0 +1,26 @@
+require 'prawn'
+require 'prawn-styled-text'
+require 'oga'
+
+html = <<~EOL
+  <h4 style="text-align: center">Some text</h4>
+  <div style="font-size: 10px; text-align: justify">Lorem ipsum dolor sit <b>amet</b>, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud <i>exercitation</i> ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in <u>reprehenderit</u> in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</div>
+EOL
+
+# html = <<~EOL
+#   <span>span 1</span>
+#   <div>div 1</div>
+#   <span>span 2</span>
+#   <div>div 2</div>
+#   <span>span 3</span>
+#   <span>span 4</span>
+#   <div>div 3</div>
+#   <div>div 4</div>
+# EOL
+
+pdf = Prawn::Document.new
+pdf.define_grid(:columns => 3, :rows => 3, :gutter => 10)
+pdf.grid( 1, 1 ).bounding_box do
+  pdf.styled_text html
+end
+pdf.render_file 'test.pdf'

data/examples/slim.rb

@@ -0,0 +1,14 @@
+require 'prawn'
+require 'prawn-styled-text'
+require 'oga'
+require 'slim'
+
+SLIM_FILE = 'test.html.slim'
+
+Prawn::Font::AFM.hide_m17n_warning = true
+
+pdf = Prawn::Document.new
+pdf.text "\nA test document\n", align: :center, size: 18
+# Slim::Template.new{ 'h1 A test document' }.render
+pdf.styled_text Slim::Template.new( SLIM_FILE ).render
+pdf.render_file 'test.pdf'

data/examples/test.html

@@ -0,0 +1,46 @@
+<h1>A test document</h1>
+This is <i style="color: #888888">italic</i>, <u>underline</u> and <b>bold, <i>bold italic</i></b>
+<br/>
+
+<hr style="color: #008800; dash: 3"/>
+<br/>
+
+<div style="text-align: left">text-align: left</div>
+<div style="text-align: center">text-align: center</div>
+<div style="text-align: right">text-align: right</div>
+<div style="text-align: justify">text-align: justify</div>
+<hr/>
+<div style="margin-top: 30px">margin-top</div>
+<div style="margin-left: 30px">margin-left</div>
+<br/>
+
+<ul>
+  <li>Level 1a</li>
+  <li>Level 1b
+    <ul style="margin-left: 8px; ul-symbol: +;">
+      <li>Level 2a</li>
+      <li>Level 2b
+        <ul style="ul-symbol: -;">
+          <li>Level 3a</li>
+          <li>Level 3b</li>
+        </ul>
+      </li>
+    </ul>
+  </li>
+</ul>
+<br/>
+
+Some HTML entities: &euro; &times; &divide; &half; &laquo; &raquo; &copy;<br/>
+
+<hr style="color: #FFBB11; dash: 1" />
+<br/>
+
+A span with a color: <span style="color: #4488CC">this is <span style="color: #ff0000; font-family: Courier; font-size: 20px">courier red 20</span>, this is <span style="color: #008800; font-style: bold, italic">green bold italic</span>, this is <span style="letter-spacing: 2">character spacing 2</span>, this is <a href="http://www.google.com">a Google link</a></span>
+<h3 style="mode: stroke">Stroke mode</h3>
+<div style="font-size: 14px; line-height: 12px">line-height test... Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.</div>
+<hr/>
+<br/>
+
+An image:
+<img src="image.jpg" style="width: 50%" />
+<!-- <img src="image.jpg" style="image-position: center; image-scale: 0.3" /> -->

data/examples/test.html.erb

@@ -0,0 +1,4 @@
+<div>Just an ERB document</div>
+<% (1..9).each do |i| %>
+  <div style="margin-left: <%= i * 10 %>px">Line <%= i %></div>
+<% end %>

data/examples/test.html.slim

@@ -0,0 +1,5 @@
+div Just a slim document
+- (1..9).each do |i|
+  div style="margin-left: #{i * 10}px"
+    | Line
+    = i

data/lib/prawn-styled-text.rb

@@ -0,0 +1 @@
+require 'prawn-styled-text/prawn-styled-text'

data/lib/prawn-styled-text/prawn-document.rb

@@ -0,0 +1,85 @@
+require 'prawn'
+
+Prawn::Document.class_eval do
+  def styled_text( data )
+    parts = []
+    text_options = {}
+    extra_options = { margin_left: 0 }
+    oga = Oga.parse_html data
+    PrawnStyledText::traverse oga.children do |type, text, data|
+      context = if type == :text_node
+          PrawnStyledText::text_node( self, data )
+        elsif type == :opening_tag
+          PrawnStyledText::opening_tag( self, data )
+        else
+          PrawnStyledText::closing_tag( self, data )
+        end
+      if context[:flush] && parts.any? # flush current parts
+        parts[0][:text] = parts[0][:text].lstrip
+        parts.shift if parts[0][:text].empty?
+        if parts.any?
+          parts[-1][:text] = parts[-1][:text].rstrip
+          parts.pop if parts[-1][:text].empty?
+        end
+        # p '###', parts
+        if parts.any?
+          parts[0][:text] = extra_options[:pre] + parts[0][:text] if extra_options[:pre]
+          self.indent( extra_options[:margin_left] ) do
+            self.formatted_text parts, text_options
+          end
+        end
+        parts = []
+        text_options = {}
+        extra_options = { margin_left: 0 }
+      end
+      options = context[:options]
+      if type == :text_node
+        # prepare options
+        text_options[:align] = options[:'text-align'].to_sym if options[:'text-align']
+        margin_top = options.delete( :'margin-top' ).to_i
+        self.move_down( margin_top ) if margin_top > 0
+        margin_left = options.delete( :'margin-left' ).to_i
+        extra_options[:margin_left] = margin_left if margin_left > 0
+        if !text_options[:leading] && ( leading = options.delete( :'line-height' ).to_i ) > 0
+          text_options[:leading] = leading
+        end
+        text_options[:mode] = options[:'mode'].to_sym if options[:'mode']
+        extra_options[:pre] = context[:pre] if context[:pre]
+        parts << { text: text }.merge( options ) # push the data
+      elsif type == :closing_tag
+        self.formatted_text( context[:text] ) if context[:text]
+        if context[:tag] == :hr
+          self.dash( options[:dash].to_i ) if options[:dash]
+          if options[:color]
+            last_stroke_color = self.stroke_color
+            self.stroke_color( options[:color] )
+          end
+          self.stroke_horizontal_rule
+          self.stroke_color( last_stroke_color ) if options[:color]
+          self.undash if options[:dash]
+        elsif context[:tag] == :img && context[:src]
+          image_options = {}
+          image_options[:scale] = options[:'image-scale'].to_f if options[:'image-scale']
+          if options[:'image-at']
+            xy = options[:'image-at'].split( ',' ).map &:to_i
+            image_options[:at] = xy if xy.count == 2
+            # p image_options[:at]
+          end
+          if options[:'image-position']
+            pos = options[:'image-position'].to_i
+            image_options[:position] = pos > 0 ? pos : options[:'image-position']
+          end
+          if options[:'width']
+            w = options[:'width'].to_i
+            if w > 0
+              image_options[:width] = options[:'width'].include?( '%' ) ? ( w * self.bounds.width * 0.01 ) : w
+            end
+          end
+          image_options[:height] = options[:'height'].to_i if options[:'height']
+          self.image context[:src], image_options
+        end
+      end
+    end
+    self.formatted_text parts, text_options
+  end
+end

data/lib/prawn-styled-text/prawn-styled-text.rb

@@ -0,0 +1,114 @@
+require 'oga'
+require_relative 'prawn-document'
+
+module PrawnStyledText
+  BLOCK_TAGS = [ :br, :div, :h1, :h2, :h3, :h4, :h5, :h6, :hr, :li, :ul ]
+  DEF_HEADING_T = 16
+  DEF_HEADING_H = 8
+  DEF_MARGIN_UL = 15
+  DEF_SYMBOL_UL = "\x95"
+  HEADINGS = { h1: 32, h2: 24, h3: 20, h4: 16, h5: 14, h6: 13 }
+  RENAME = { 'font-family': :font, 'font-size': :size, 'font-style': :styles, 'letter-spacing': :character_spacing }
+
+  @@margin_ul = 0
+  @@symbol_ul = ''
+
+  def self.adjust_values( values )
+    ret = {}
+    values.each do |k, v|
+      key = k.to_sym
+      key = RENAME[key] if RENAME.include?( key )
+      ret[key] = case key
+        when :character_spacing
+          v.to_f
+        when :color
+          v.delete '#'
+        when :size
+          v.to_i
+        when :styles
+          v.split( ',' ).map { |s| s.strip.to_sym }
+        else
+          v
+        end
+    end
+    ret
+  end
+
+  def self.closing_tag( pdf, data )
+    context = { tag: data[:name], options: {} }
+    context[:flush] ||= true if BLOCK_TAGS.include? data[:name]
+    # Evalutate tag
+    case data[:name]
+    when :br # new line
+      context[:text] ||= [ { text: "\n" } ]
+    when :img # image
+      context[:flush] ||= true
+      context[:src] = data[:node].get 'src'
+    when :ul
+      @@margin_ul = 0
+    end
+    # Evalutate attributes
+    attributes = data[:node].get 'style'
+    context[:options] = adjust_values( attributes.scan( /\s*([^:]+):\s*([^;]+)[;]*/ ) ) if attributes
+    context
+  end
+
+  def self.opening_tag( pdf, data )
+    context = { tag: data[:name], options: {} }
+    context[:flush] ||= true if BLOCK_TAGS.include? data[:name]
+    # Evalutate attributes
+    attributes = data[:node].get 'style'
+    context[:options].merge!( adjust_values( attributes.scan( /\s*([^:]+):\s*([^;]+)[;]*/ ) ) ) if attributes
+    if data[:name] == :ul
+      @@margin_ul += ( context[:options][:'margin-left'] ? context[:options][:'margin-left'].to_i : DEF_MARGIN_UL )
+      @@symbol_ul = context[:options][:'ul-symbol'] ? context[:options][:'ul-symbol'] : DEF_SYMBOL_UL
+    end
+    context
+  end
+
+  def self.text_node( pdf, data )
+    context = { pre: '', options: {} }
+    styles = []
+    data.each do |part|
+      # Evalutate tag
+      tag = part[:name]
+      case tag
+      when :a # link
+        link = part[:node].get 'href'
+        context[:options][:link] = link if link
+      when :b # bold
+        styles.push :bold
+      when :h1, :h2, :h3, :h4, :h5, :h6
+        context[:options][:size] = HEADINGS[tag]
+        context[:options][:'margin-top'] = DEF_HEADING_T
+        context[:options][:'line-height'] = DEF_HEADING_H
+      when :i # italic
+        styles.push :italic
+      when :li # list item
+        context[:options][:'margin-left'] = @@margin_ul
+        context[:pre] = @@symbol_ul.force_encoding( 'windows-1252' ).encode( 'UTF-8' ) + ' '
+      when :u # underline
+        styles.push :underline
+      end
+      context[:options][:styles] = styles if styles.any?
+      # Evalutate attributes
+      attributes = part[:node].get 'style'
+      context[:options].merge!( adjust_values( attributes.scan( /\s*([^:]+):\s*([^;]+)[;]*/ ) ) ) if attributes
+    end
+    context
+  end
+
+  def self.traverse( nodes, context = [], &block )
+    nodes.each do |node|
+      if node.is_a? Oga::XML::Text
+        yield :text_node, node.text.delete( "\n\r" ), context
+      elsif node.is_a? Oga::XML::Element
+        element = { name: node.name.to_sym, node: node }
+        yield :opening_tag, element[:name], element
+        context.push( element )
+        traverse( node.children, context, &block ) if node.children.count > 0
+        yield :closing_tag, element[:name], context.pop
+      end
+    end
+  end
+end

data/lib/prawn-styled-text/version.rb

@@ -0,0 +1,3 @@
+module PrawnStyledText
+  VERSION = '0.1.0'
+end

data/prawn-styled-text.gemspec

@@ -0,0 +1,20 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prawn-styled-text/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prawn-styled-text'
+  spec.version       = PrawnStyledText::VERSION
+  spec.summary       = 'Prawn PDF styled text'
+  spec.description   = 'A Prawn PDF component which adds basic HTML support'
+  spec.license       = 'MIT'
+  spec.authors       = ['Mattia Roccoberton']
+  spec.email         = 'mat@blocknot.es'
+  spec.homepage      = 'https://github.com/blocknotes/prawn-styled-text'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'prawn', '~> 2'
+  spec.add_runtime_dependency 'oga', '~> 2'
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: prawn-styled-text
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattia Roccoberton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: oga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: A Prawn PDF component which adds basic HTML support
+email: mat@blocknot.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- examples/basic.rb
+- examples/columns.rb
+- examples/erb.rb
+- examples/grid.rb
+- examples/image.jpg
+- examples/slim.rb
+- examples/test.html
+- examples/test.html.erb
+- examples/test.html.slim
+- lib/prawn-styled-text.rb
+- lib/prawn-styled-text/prawn-document.rb
+- lib/prawn-styled-text/prawn-styled-text.rb
+- lib/prawn-styled-text/version.rb
+- prawn-styled-text.gemspec
+homepage: https://github.com/blocknotes/prawn-styled-text
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Prawn PDF styled text
+test_files: []