prawn-styled-text 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ba40b18a996a3e69cc3f7de86b848f47bc60cdf
-  data.tar.gz: 0d81d2354ab51749b9e71d1bd5ae940a8da1422f
+  metadata.gz: c73fb17ed91bd33843991a644f9c635c2d2cfaa5
+  data.tar.gz: 57aad42cddc27f7302df26aba88ae5379a3c1f5e
 SHA512:
-  metadata.gz: 0d6de625118e03cd18abd32d1fed3b76f1f65d4e16548c11c255b5f7c439dce5eaea9fde269e5f57db6f87f2cfe5e3e8d90c48ee483fc790abc6f392b574bae7
-  data.tar.gz: 7f8a022711c08293aba2d950128dd959b0f39d259a9a227cb994a9046d4bcc80fe022f75a3cf37a9abe16a1fb0d5a140aac2787da5ee4ec468dfb632c8b478ae
+  metadata.gz: 1fbcaead4bdf4d53477cd4195b62032492056a29d5a33e78cf13c9c878814b2d798df50e872fdbaa29a768e5cf085bdb7592d75298ac86fd6b30914416312c87
+  data.tar.gz: b90e425105862e661321e3dd54295d73e9cf3ba0e3cab74a41f4a4dbcb31a0c6752537cb7d31a747762b7e1c1ac3cb50a1a205e2f94b9c131fcdd9364a64552e

data/README.md

@@ -20,26 +20,33 @@ For more examples see this [folder](https://github.com/blocknotes/prawn-styled-t
 ## Supported tags & attributes
 
 HTML tags:
-- a
-- b
-- br 
-- div
-- em
-- h1 - h6
-- hr
-- i
-- img
-- p
-- span
-- strong
-- u
-- ul / li
+- a (link)
+- b (bold)
+- br (new line)
+- 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)
+- p (block element)
+- s (strike-through)
+- small (smaller text)
+- span (inline element)
+- strong (bold)
+- u (underline)
+- ul (list)
 
 CSS attributes:
+- background (for *mark* tag, only 6 hex digits format, # is ignored - ex. `style="background: #FFCC00"`)
 - 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"`)
+- font-style (*:bold*, *:bold_italic*, *:italic*, *:normal*; 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"`)
@@ -52,6 +59,7 @@ CSS attributes:
 
 Olther attributes:
 - dash (for *hr* tag, ex. `<hr style="dash: 4"/>`)
+- image-at (for *img* tag, origin (0, 0) is left bottom, ex. `<img src="image.jpg" style="image-at: 100, 600" />`)
 - 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: -">`)

data/examples/test.html

@@ -1,4 +1,4 @@
-<h1>A test document</h1>
+<h1>A test document <small>(with the supported elements)</small></h1>
 This is <i style="color: #888888">italic</i>, <u>underline</u> and <b>bold, <i>bold italic</i></b>
 <br/>
 
@@ -9,7 +9,7 @@ This is <i style="color: #888888">italic</i>, <u>underline</u> and <b>bold, <i>b
 <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/>
+<hr style="dash: 5, 5, 1, 5"/>
 <div style="margin-top: 30px">margin-top</div>
 <div style="margin-left: 30px">margin-left</div>
 <br/>
@@ -31,16 +31,17 @@ This is <i style="color: #888888">italic</i>, <u>underline</u> and <b>bold, <i>b
 <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" />
+<p>A paragraph</p><p>Another paragraph with <mark style="background: #ffbb11">highlight words</mark> and <del>deleted words</del>.</p>
+<hr style="color: #ff00ff; 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; 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>
+<div style="font-size: 14px; line-height: 12px; text-align: justify">line-height test... Lorem ipsum dolor sit amet, consectetur <small>adipisicing</small> 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.</div>
 <hr/>
 <br/>
 
 An image:
 <img src="image.jpg" style="width: 50%" />
+<!-- <img src="image.jpg" style="image-at: 100, 600" /> -->
 <!-- <img src="image.jpg" style="image-position: center; image-scale: 0.3" /> -->

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

@@ -0,0 +1,31 @@
+module PrawnStyledText
+  class HighlightCallback
+    def initialize( pdf )
+      @document = pdf
+    end
+
+    def set_color( color )
+      @color = color ? color : DEF_BG_MARK
+    end
+
+    def render_behind( fragment )
+      original_color       = @document.fill_color
+      @document.fill_color = @color
+      @document.fill_rectangle(fragment.top_left, fragment.width, fragment.height)
+      @document.fill_color = original_color
+    end
+  end
+
+  class StrikeThroughCallback
+    def initialize( pdf )
+      @document = pdf
+    end
+
+    def render_in_front( fragment )
+      y = ( fragment.top_left[1] + fragment.bottom_left[1] ) / 2
+      @document.stroke do
+        @document.line [ fragment.top_left[0], y ], [ fragment.top_right[0], y ]
+      end
+    end
+  end
+end

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

@@ -21,7 +21,6 @@ Prawn::Document.class_eval do
           parts[-1][:text] = parts[-1][:text].rstrip
           parts.pop if parts[-1][:text].empty?
         end
-        # 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,9 +32,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']
         margin_top = options.delete( :'margin-top' ).to_i
         self.move_down( margin_top ) if margin_top > 0
@@ -44,13 +41,13 @@ Prawn::Document.class_eval do
         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']
+        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]
+          self.dash( options[:dash].include?( ',' ) ? options[:dash].split( ',' ).map( &:to_i ) : options[:dash].to_i ) if options[:dash]
           if options[:color]
             last_stroke_color = self.stroke_color
             self.stroke_color( options[:color] )

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

@@ -1,8 +1,10 @@
 require 'oga'
+require_relative 'callbacks'
 require_relative 'prawn-document'
 
 module PrawnStyledText
   BLOCK_TAGS = [ :br, :div, :h1, :h2, :h3, :h4, :h5, :h6, :hr, :li, :p, :ul ]
+  DEF_BG_MARK = 'ffff00'
   DEF_HEADING_T = 16
   DEF_HEADING_H = 8
   DEF_MARGIN_UL = 15
@@ -83,6 +85,7 @@ module PrawnStyledText
   def self.text_node( pdf, data )
     context = { pre: '', options: {} }
     styles = []
+    font_size = pdf.font_size
     data.each do |part|
       # Evalutate tag
       tag = part[:name]
@@ -92,6 +95,9 @@ module PrawnStyledText
         context[:options][:link] = link if link
       when :b, :strong # bold
         styles.push :bold
+      when :del, :s
+        @@strike_through ||= StrikeThroughCallback.new( pdf )
+        context[:options][:callback] = @@strike_through
       when :h1, :h2, :h3, :h4, :h5, :h6
         context[:options][:size] = HEADINGS[tag]
         context[:options][:'margin-top'] = DEF_HEADING_T
@@ -101,13 +107,24 @@ module PrawnStyledText
       when :li # list item
         context[:options][:'margin-left'] = @@margin_ul
         context[:pre] = @@symbol_ul.force_encoding( 'windows-1252' ).encode( 'UTF-8' )
-      when :u # underline
+      when :mark
+        @@highlight ||= HighlightCallback.new( pdf )
+        @@highlight.set_color nil
+        context[:options][:callback] = @@highlight
+      when :small
+        context[:options][:size] = font_size * 0.66
+      when :u, :ins # underline
         styles.push :underline
       end
       context[:options][:styles] = styles if styles.any?
       # Evalutate attributes
       attributes = part[:node].get 'style'
-      context[:options].merge!( adjust_values( pdf, attributes.scan( /\s*([^:]+):\s*([^;]+)[;]*/ ) ) ) if attributes
+      if attributes
+        values = adjust_values( pdf, attributes.scan( /\s*([^:]+):\s*([^;]+)[;]*/ ) )
+        @@highlight.set_color( values[:background].delete( '#' ) ) if tag == :mark && values[:background]
+        context[:options].merge! values
+      end
+      font_size = context[:options][:size] if font_size
     end
     context
   end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prawn-styled-text
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prawn
@@ -58,6 +58,7 @@ files:
 - examples/test.html.erb
 - examples/test.html.slim
 - lib/prawn-styled-text.rb
+- lib/prawn-styled-text/callbacks.rb
 - lib/prawn-styled-text/prawn-document.rb
 - lib/prawn-styled-text/prawn-styled-text.rb
 - lib/prawn-styled-text/version.rb