prawn-styled-text 0.1.0 → 0.1.2

checksums.yaml

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

data/README.md

@@ -4,6 +4,19 @@ 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
 
+Install with `gem install prawn-styled-text` or using bundler `gem 'prawn-styled-text'`
+
+## Examples
+
+```ruby
+require 'prawn-styled-text'
+pdf = Prawn::Document.new
+pdf.styled_text '<h1 style="text-align: center">Just a test</h1>'
+pdf.render_file 'test.pdf'
+```
+
+For more examples see this [folder](https://github.com/blocknotes/prawn-styled-text/tree/master/examples).
+
 ## Supported tags & attributes
 
 HTML tags:
@@ -11,30 +24,40 @@ HTML tags:
 - b
 - br 
 - div
+- em
 - h1 - h6
 - hr
 - i
 - img
+- p
 - span
+- strong
 - 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
+- color (only 6 hex digits format, # is ignored - ex. `style="color: #FFBB11"`)
+- font-family (ex. `style="font: Courier"`)
+- font-size (units are ignored - ex. `style="font-size: 20px"`)
+- font-style (accepts list of values - ex. `style="font-style: bold, italic"`)
+- height (for *img* tag, ex. `<img src="test.jpg" style="width: 50%; height: 200"/>`)
+- href (for *a* tag, ex. `<a href="http://www.google.com/">Google</a>`)
+- letter-spacing (ex. `style="letter-spacing: 1.5"`)
+- line-height (heading, units are ignored - ex. `style="line-height: 10"`)
+- margin-left (units are ignored - ex. `style="margin-left: 15"`)
+- margin-top (units are ignored - ex. `style="margin-top: 20"`)
+- src (for *img* tag, ex. `<img src="test.jpg"/>`)
+- text-align (ex. `style="text-align: center"`)
+- width (for *img* tag, ex. `<img src="test.jpg" style="width: 50%; height: 200"/>`)
 
-## Examples
+Olther attributes:
+- dash (for *hr* tag, ex. `<hr style="dash: 4"/>`)
+- image-position (for *img* tag, ex. `<img src="image.jpg" style="image-position: center" />`)
+- image-scale (for *img* tag, ex. `<img src="image.jpg" style="image-scale: 0.3" />`)
+- list-symbol (for *ul* tag, ex. `<ul style="list-symbol: -">`)
+- mode (ex. `<h3 style="mode: stroke">Stroke text</h3>`)
 
-See [examples](https://github.com/blocknotes/prawn-styled-text/tree/master/examples) folder.
+See [Prawn documentation](https://github.com/prawnpdf/prawn-table#documentation) for PDF options details.
 
 ## Contributors
 

data/examples/test.html

@@ -17,10 +17,10 @@ This is <i style="color: #888888">italic</i>, <u>underline</u> and <b>bold, <i>b
 <ul>
   <li>Level 1a</li>
   <li>Level 1b
-    <ul style="margin-left: 8px; ul-symbol: +;">
+    <ul style="margin-left: 8px; list-symbol: '+ ';">
       <li>Level 2a</li>
       <li>Level 2b
-        <ul style="ul-symbol: -;">
+        <ul style="list-symbol: ''">
           <li>Level 3a</li>
           <li>Level 3b</li>
         </ul>
@@ -30,14 +30,14 @@ This is <i style="color: #888888">italic</i>, <u>underline</u> and <b>bold, <i>b
 </ul>
 <br/>
 
-Some HTML entities: &euro; &times; &divide; &half; &laquo; &raquo; &copy;<br/>
-
+Some HTML entities: &euro; &times; &divide; &half; &laquo; &raquo; &copy;
+<p>A paragraph</p><p>Another paragraph</p>
 <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>
+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>
+<div style="font-size: 14px; line-height: 12px; text-align: justify">line-height test... Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod <em>tempor</em> 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 <strong>dolor</strong> in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.</div>
 <hr/>
 <br/>
 

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

@@ -21,7 +21,7 @@ Prawn::Document.class_eval do
           parts[-1][:text] = parts[-1][:text].rstrip
           parts.pop if parts[-1][:text].empty?
         end
-        # p '###', parts
+        # p '###', parts ### DEBUG
         if parts.any?
           parts[0][:text] = extra_options[:pre] + parts[0][:text] if extra_options[:pre]
           self.indent( extra_options[:margin_left] ) do
@@ -33,6 +33,7 @@ Prawn::Document.class_eval do
         extra_options = { margin_left: 0 }
       end
       options = context[:options]
+      # p '@@@', options ### DEBUG
       if type == :text_node
         # prepare options
         text_options[:align] = options[:'text-align'].to_sym if options[:'text-align']
@@ -63,19 +64,13 @@ Prawn::Document.class_eval do
           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']
+          image_options[:width]  = options[:width]  if options[:width]
+          image_options[:height] = options[:height] if options[:height]
           self.image context[:src], image_options
         end
       end

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

@@ -2,18 +2,18 @@ require 'oga'
 require_relative 'prawn-document'
 
 module PrawnStyledText
-  BLOCK_TAGS = [ :br, :div, :h1, :h2, :h3, :h4, :h5, :h6, :hr, :li, :ul ]
+  BLOCK_TAGS = [ :br, :div, :h1, :h2, :h3, :h4, :h5, :h6, :hr, :li, :p, :ul ]
   DEF_HEADING_T = 16
   DEF_HEADING_H = 8
   DEF_MARGIN_UL = 15
-  DEF_SYMBOL_UL = "\x95"
+  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 )
+  def self.adjust_values( pdf, values )
     ret = {}
     values.each do |k, v|
       key = k.to_sym
@@ -23,10 +23,19 @@ module PrawnStyledText
           v.to_f
         when :color
           v.delete '#'
+        when :font
+          matches = v.match /'([^']*)'|"([^"]*)"|(.*)/
+          matches[3] || matches[2] || matches[1] || ''
+        when :height
+          i = v.to_i
+          v.include?( '%' ) ? ( i * pdf.bounds.height * 0.01 ) : i
         when :size
           v.to_i
         when :styles
           v.split( ',' ).map { |s| s.strip.to_sym }
+        when :width
+          i = v.to_i
+          v.include?( '%' ) ? ( i * pdf.bounds.width * 0.01 ) : i
         else
           v
         end
@@ -49,7 +58,7 @@ module PrawnStyledText
     end
     # Evalutate attributes
     attributes = data[:node].get 'style'
-    context[:options] = adjust_values( attributes.scan( /\s*([^:]+):\s*([^;]+)[;]*/ ) ) if attributes
+    context[:options] = adjust_values( pdf, attributes.scan( /\s*([^:]+):\s*([^;]+)[;]*/ ) ) if attributes
     context
   end
 
@@ -58,10 +67,15 @@ module PrawnStyledText
     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
+    context[:options].merge!( adjust_values( pdf, 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
+      @@symbol_ul = if context[:options][:'list-symbol']
+          matches = context[:options][:'list-symbol'].match /'([^']*)'|"([^"]*)"|(.*)/
+          matches[3] || matches[2] || matches[1] || ''
+        else
+          DEF_SYMBOL_UL
+        end
     end
     context
   end
@@ -76,24 +90,24 @@ module PrawnStyledText
       when :a # link
         link = part[:node].get 'href'
         context[:options][:link] = link if link
-      when :b # bold
+      when :b, :strong # 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
+      when :i, :em # 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' ) + ' '
+        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
+      context[:options].merge!( adjust_values( pdf, attributes.scan( /\s*([^:]+):\s*([^;]+)[;]*/ ) ) ) if attributes
     end
     context
   end

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prawn-styled-text
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Mattia Roccoberton