rfpdf 1.17.3 → 1.17.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63d0b7d1a6a69589d3929d473835804e9c373bcb
-  data.tar.gz: de62737227cba9fecdd59544b451ad61001c9b2c
+  metadata.gz: 796b6a1fe25a0c554d948c5c28ef2610484f25db
+  data.tar.gz: b3c31fb2d5e7fd0967df31960b160df0a8262a07
 SHA512:
-  metadata.gz: ff4b63ed0ac855ac2d8c712222f4bb954086e398a0940156e6e678717fb408b4704d0e82a9f9de59249bd288e19ed34bf5b349895ea87de2d9a1333e1a6b8446
-  data.tar.gz: 2bf37c098e1240e968f83244fdcada9c04b054b8da175f7f2b2ece1a8ae3a9269f1411c339e04bdda6f491e66342cf1b3bd5f0272654f50cbd501292b1a1d0ff
+  metadata.gz: b82b68c5973fc2eed86fd8ac2307c7f8158a7f6917878ae46874fca684bfc5ace5b0dd79dae0bfed9f2c54159089cbfaff4e4d75a07084e2d275ad8c3274b916
+  data.tar.gz: b20b66eabb47b0806599d47f78012e855072b990a3aa74ce93125d24cd8d89fc5f9d7d7ddeac4250baf432e937264a8c94ce69a02d4fd4cc9086b2c365ba6acc

data/CHANGELOG

@@ -17,4 +17,8 @@ put your assignment in a before_filter (perhaps overriding :filename, etc in you
 1.17   2014-05-18 Update base version to TCPDF 5.1.002. Ruby 2.0/2.1 support. FPDF is deprecated.
 1.17.2 2014-07-09 FreeSerif font added from GNU FreeFont(20080912).
 1.17.3 2014-07-16 Several bug fixed.
+1.17.4 2014-07-28
+                  - getNumLines, getStringHeight, getMargins function added.
+                  - fix large image file page break bug.
+
 

data/README.md

@@ -0,0 +1,68 @@
+
+# RFPDF Template Plugin
+
+A template plugin allowing the inclusion of ERB-enabled RFPDF template files.
+
+##
+##
+## TCPDF Version (The New or UTF8 Version)
+##
+##
+
+* Use UTF-8 encoding. 
+* RTL (Right-To-Left) languages support.
+* HTML tag support.
+* CSS minimum support.
+* Image
+ - 8bit PNG image support without RMagick liblary.
+ - PNG/JPEG/GIF image support. (use RMagick liblary)
+
+
+##
+## Installing RFPDF
+##
+
+RFPDF is distributed via RubyGems, and can be installed the usual way that you install gems: by simply typing `gem install rfpdf` on the command line. 
+
+==
+
+If you are using HTML, it is recommended you install:
+```
+gem install htmlentities
+```
+
+If you are using image file, it is recommended you install:
+```
+gem install rmagick
+```
+
+TCPDF Example of simple use in .html.erb:
+
+```
+<%
+  @pdf = TCPDF.new()
+  @pdf.set_margins(15, 27, 15)
+  @pdf.set_font('FreeSans','', 8)
+  @pdf.add_page()
+  @pdf.write(5, "text\n", '')
+%><%==@pdf.output()%>
+```
+
+TCPDF Japanese Example of simple use in .html.erb:
+```
+<%
+  @pdf = TCPDF.new()
+  @pdf.set_margins(15, 27, 15)
+  @pdf.set_font('kozminproregular','', 8)
+  @pdf.add_page()
+  @pdf.write(5, "UTF-8 Japanese text.\n", '')
+%><%==@pdf.output()%>
+```
+
+See the following files for sample of useage:
+
+test_unicode.rfpdf
+utf8test.txt
+logo_example.png
+
+ENJOY!

data/lib/rfpdf/version.rb

@@ -1,3 +1,3 @@
 module Rfpdf
-  VERSION = "1.17.3"
+  VERSION = "1.17.4"
 end

data/lib/tcpdf.rb

@@ -124,8 +124,6 @@ class TCPDF
   
   attr_accessor :color_flag
   
-  attr_accessor :default_table_columns
-  
   attr_accessor :default_font
 
   attr_accessor :draw_color
@@ -278,7 +276,6 @@ class TCPDF
     @header_logo_width ||= 30
     @header_title ||= ""
     @header_string ||= ""
-    @default_table_columns ||= 4
     @listordered ||= []
     @listcount ||= []
     @listindent ||= 0
@@ -3352,6 +3349,7 @@ class TCPDF
   # [@see] Cell()
   #
   def getCellCode(w, h=0, txt='', border=0, ln=0, align='', fill=0, link=nil, stretch=0, ignore_min_height=false, calign='T', valign='M')
+    txt = '' if txt.nil?
     rs = "" # string to be returned
     txt = removeSHY(txt)
     if !ignore_min_height
@@ -4024,6 +4022,151 @@ class TCPDF
   end
   protected :getBorderMode
 
+  #
+  # This method return the estimated number of lines for print a simple text string in Multicell() method.
+  # [@param string :txt] String for calculating his height
+  # [@param float :w] Width of cells. If 0, they extend up to the right margin of the page.
+  # [@param boolean :reseth] if true reset the last cell height (default false).
+  # [@param boolean :autopadding] if true, uses internal padding and automatically adjust it to account for line width (default true).
+  # [@param float :cellMargin] Internal cell margin, if empty or <= 0, extended up to current pdf cell margin (default '').
+  # [@param float :lineWidth] Line width, if empty or <= 0, extended up to current pdf line width (default '').
+  # [@return float] Return the minimal height needed for multicell method for printing the :txt param.
+  # [@author] Alexander Escalona Fernendez, Nicola Asuni
+  # [@access public]
+  # [@since 4.5.011]
+  #
+  def getNumLines(txt, w=0, reseth=false, autopadding=true, cellMargin='', lineWidth='')
+    if empty_string(w) or (w <= 0)
+      if @rtl
+        w = @x - @l_margin
+      else
+        w = @w - @r_margin - @x
+      end
+    end
+    if empty_string(cellMargin) or (cellMargin <= 0)
+      cellMargin = @c_margin
+    end
+    if empty_string(lineWidth) or (lineWidth <= 0)
+      lineWidth = @line_width
+    end
+    if autopadding
+      # adjust internal padding
+      if cellMargin < (lineWidth / 2)
+        cellMargin = lineWidth / 2
+      end
+    end
+    wmax = w - (2 * cellMargin)
+    if reseth
+      @lasth = @font_size * @cell_height_ratio
+    end
+    lines = 1
+    sum = 0
+    chars = UTF8StringToArray(txt)
+    chars = utf8Bidi(chars, txt, @tmprtl)
+    charsWidth = GetArrStringWidth(chars, '', '', 0, true)
+    if @rtl
+      charsWidth.reverse!
+      chars.reverse!
+    end
+    length = chars.length
+    lastSeparator = -1
+
+    i = 0
+    while i < length
+      charWidth = charsWidth[i]
+      if unichr(chars[i]) =~ /\s/
+        lastSeparator = i
+      end
+      if sum + charWidth >= wmax 
+        lines += 1
+        if lastSeparator != -1
+          i = lastSeparator
+          lastSeparator = -1
+          sum = 0
+        else
+          sum = charWidth
+        end
+      else
+        sum += charWidth
+      end
+      i += 1
+    end
+    return lines
+  end
+  alias_method :get_num_lines, :getNumLines
+
+  #
+  # This method return the estimated needed height for print a simple text string in Multicell() method.
+  # Generally, if you want to know the exact height for a block of content you can use the following technique:
+  # 
+  #   # store current object
+  #   pdf.start_transaction()
+  #   # store starting values
+  #   start_y = pdf.get_y()
+  #   start_page = pdf.get_page()
+  #   # call your printing functions with your parameters
+  #   # - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  #   pdf.multi_cell(w=0, h=0, txt, border=1, align='L', fill=0, ln=1, x='', y='', reseth=true, stretch=0, ishtml=false, autopadding=true, maxh=0)
+  #   # - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+  #   # get the new Y
+  #   end_y = pdf.get_y()
+  #   end_page = pdf.get_page()
+  #   # calculate height
+  #   height = 0
+  #   if end_page == start_page
+  #     height = end_y - start_y
+  #   else
+  #     start_page.upto(end_page) do |page|
+  #       pdf.set_page(page)
+  #       if page == start_page
+  #         # first page
+  #         height = @h - start_y - @b_margin
+  #       elsif page == end_page
+  #         # last page
+  #         height = end_y - @t_margin
+  #       else
+  #         height = @h - @t_margin - @b_margin
+  #       end
+  #     end
+  #   end
+  #   # restore previous object
+  #   pdf = pdf.rollbackTransaction()
+  # 
+  # [@param float :w] Width of cells. If 0, they extend up to the right margin of the page.
+  # [@param string :txt] String for calculating his height
+  # [@param boolean :reseth] if true reset the last cell height (default false).
+  # [@param boolean :autopadding] if true, uses internal padding and automatically adjust it to account for line width (default true).
+  # [@param float :cellMargin] Internal cell margin, if empty or <= 0, extended up to current pdf cell margin (default '').
+  # [@param float :lineWidth] Line width, if empty or <= 0, extended up to current pdf line width (default '').
+  # [@return float] Return the minimal height needed for multicell method for printing the :txt param.
+  # [@author] Nicola Asuni, Alexander Escalona Fern<E1>ndez
+  # [@access public]
+  #
+  def getStringHeight(w, txt, reseth=false, autopadding=true, cellMargin='', lineWidth='')
+    lines = getNumLines(txt, w, reseth, autopadding, cellMargin, lineWidth)
+    height = lines * (@font_size * @cell_height_ratio)
+    if autopadding
+      if empty_string(cellMargin) or (cellMargin <= 0)
+        cellMargin = @c_margin
+      end
+      if empty_string(lineWidth) or (lineWidth <= 0)
+        lineWidth = @line_width
+      end
+      # adjust internal padding
+      if cellMargin < (lineWidth / 2)
+        cellMargin = lineWidth / 2
+      end
+      # add top and bottom space if needed
+      if (@lasth - @font_size) < lineWidth
+        height += lineWidth
+      end
+      # add top and bottom padding
+      height += 2 * cellMargin
+    end
+    return height
+  end
+  alias_method :get_string_height, :getStringHeight
+
   #
   # This method prints text from the current position.
   # [@param float :h] Line height
@@ -4618,6 +4761,23 @@ class TCPDF
         w = h * pixw / pixh
       end
     end
+
+    # resize image to be contained on a single page          # fix at page break case.
+    if fitonpage
+      ratio_wh = w / h
+      if (@t_margin + h) > @page_break_trigger
+        h = @page_break_trigger - @t_margin
+        w = h * ratio_wh
+      end
+      if !@rtl and ((x + w) > (@w - @r_margin))
+        w = @w - @r_margin - x
+        h = w / ratio_wh
+      elsif @rtl and ((x - w) < @l_margin)
+        w = x - @l_margin
+        h = w / ratio_wh
+      end
+    end
+
     # Check whether we need a new page first as this does not fit
     prev_x = @x
     if checkPageBreak(h, y)
@@ -9949,6 +10109,35 @@ public
   alias_method :write_barcode, :writeBarcode
 =end
   
+  #
+  # Returns an array containing current margins:
+  #
+  #  * ret['left'] = left  margin
+  #  * ret['right'] = right margin
+  #  * ret['top'] = top margin
+  #  * ret['bottom'] = bottom margin
+  #  * ret['header'] = header margin
+  #  * ret['footer'] = footer margin
+  #  * ret['cell'] = cell margin
+  #
+  # [@return array] containing all margins measures
+  # [@access public]
+  # [@since 3.2.000 (2008-06-23)]
+  #
+  def getMargins()
+    ret = {
+        'left' => @l_margin,
+        'right' => @r_margin,
+        'top' => @t_margin,
+        'bottom' => @b_margin,
+        'header' => @header_margin,
+        'footer' => @footer_margin,
+        'cell' => @c_margin,
+    }
+    return ret
+  end
+  alias_method :get_margins, :getMargins
+
   #
   # Returns an array containing original margins:
   #   ret['left'] = left  margin

data/rfpdf.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
                        Dir.glob("lib/fonts/dejavu-fonts-ttf-*/{AUTHORS,BUGS,LICENSE,NEWS,README}") +
                        Dir.glob("test/*") +
                        ["Rakefile", "rfpdf.gemspec", "Gemfile",
-                        "CHANGELOG", "test_unicode.rfpdf",
+                        "CHANGELOG", "test_unicode.rfpdf", "README.md",
                         "utf8test.txt", "logo_example.png" ]
   spec.rdoc_options  += [ '--exclude', 'lib/fonts/',
                           '--exclude', 'lib/htmlcolors.rb',

data/test/tcpdf_cell_test.rb

@@ -51,4 +51,182 @@ class TcpdfTest < ActiveSupport::TestCase
     #    [(abc)] TJ
     # ET
   end
+
+  test "getStringHeight Basic test" do
+    pdf = TCPDF.new('P', 'mm', 'A4', true, "UTF-8", true)
+    pdf.add_page
+
+    txt = 'abcdefg'
+
+    w = 50
+    y1 = pdf.get_y
+    pdf.multi_cell(w, 0, txt)
+    pno = pdf.get_page
+    assert_equal pno, 1
+    y2 = pdf.get_y
+    h1 = y2 - y1
+
+    h2 = pdf.getStringHeight(w, txt)
+    assert_in_delta h1, h2, 0.01
+
+    line = pdf.get_num_lines(txt, w)
+    assert_equal line, 1
+
+    w = 20
+    y1 = pdf.get_y
+    pdf.multi_cell(w, 0, txt)
+    pno = pdf.get_page
+    assert_equal pno, 1
+    y2 = pdf.get_y
+    h1 = y2 - y1
+
+    h2 = pdf.getStringHeight(w, txt)
+    assert_in_delta h1, h2, 0.01
+
+    line = pdf.get_num_lines(txt, w)
+    assert_equal line, 1
+  end
+
+  test "getStringHeight Line Break test" do
+    pdf = TCPDF.new('P', 'mm', 'A4', true, "UTF-8", true)
+    pdf.add_page
+
+    txt = 'abcdefg'
+
+    w = 10
+    y1 = pdf.get_y
+    pdf.multi_cell(w, 0, txt)
+    pno = pdf.get_page
+    assert_equal pno, 1
+    y2 = pdf.get_y
+    h1 = y2 - y1
+
+    h2 = pdf.getStringHeight(w, txt)
+    assert_in_delta h1, h2, 0.01
+
+    line = pdf.get_num_lines(txt, w)
+    assert_equal line, 3
+
+
+    w = 5
+    y1 = pdf.get_y
+    pdf.multi_cell(w, 0, txt)
+    pno = pdf.get_page
+    assert_equal pno, 1
+    y2 = pdf.get_y
+    h1 = y2 - y1
+
+    h2 = pdf.getStringHeight(w, txt)
+    assert_in_delta h1, h2, 0.01
+
+    line = pdf.get_num_lines(txt, w)
+    assert_equal line, 7
+  end
+
+  test "getStringHeight Minimum Width test 1" do
+    pdf = TCPDF.new('P', 'mm', 'A4', true, "UTF-8", true)
+    pdf.add_page
+
+    w = pdf.get_string_width('OO')
+
+    txt = "Export to PDF: align is Good."
+
+    y1 = pdf.get_y
+    pdf.multi_cell(w, 0, txt)
+    pno = pdf.get_page
+    assert_equal pno, 1
+    y2 = pdf.get_y
+    h1 = y2 - y1
+
+    h2 = pdf.getStringHeight(w, txt)
+    assert_in_delta h1, h2, 0.01
+
+    line = pdf.get_num_lines(txt, w)
+    assert_equal line, 16
+  end
+
+ test "getStringHeight Minimum Width test 2" do
+    pdf = TCPDF.new('L', 'mm', 'A4', true, "UTF-8", true)
+    pdf.set_font('kozminproregular', '', 8)
+    pdf.add_page
+
+    margins = pdf.get_margins
+    w = pdf.get_string_width('20') + margins['cell'] * 2
+
+    txt = "20"
+
+    y1 = pdf.get_y
+    pdf.multi_cell(w, 0, txt)
+    pno = pdf.get_page
+    assert_equal pno, 1
+    y2 = pdf.get_y
+    h1 = y2 - y1
+
+    h2 = pdf.getStringHeight(w, txt)
+    assert_in_delta h1, h2, 0.01
+
+    line = pdf.get_num_lines(txt, w)
+    assert_equal line, 2
+  end
+
+  test "getStringHeight Minimum Bidi test 1" do
+    pdf = TCPDF.new('P', 'mm', 'A4', true, "UTF-8", true)
+    pdf.add_page
+
+    w = pdf.get_string_width('OO')
+
+    txt  = "\xd7\xa2\xd7\x91\xd7\xa8\xd7\x99\xd7\xaa"
+    y1 = pdf.get_y
+    pdf.multi_cell(w, 0, txt)
+    pno = pdf.get_page
+    assert_equal pno, 1
+    y2 = pdf.get_y
+    h1 = y2 - y1
+    h2 = pdf.getStringHeight(w, txt)
+    assert_in_delta h1, h2, 0.01
+
+    line = pdf.get_num_lines(txt, w)
+    assert_equal line, 5
+
+    txt = "? \xd7\x93\xd7\x92 \xd7\xa1\xd7\xa7\xd7\xa8\xd7\x9f \xd7\xa9\xd7\x98 \xd7\x91\xd7\x99\xd7\x9d \xd7\x9e\xd7\x90\xd7\x95\xd7\x9b\xd7\x96\xd7\x91 \xd7\x95\xd7\x9c\xd7\xa4\xd7\xaa\xd7\xa2 \xd7\x9e\xd7\xa6\xd7\x90 \xd7\x9c\xd7\x95 \xd7\x97\xd7\x91\xd7\xa8\xd7\x94 \xd7\x90\xd7\x99\xd7\x9a \xd7\x94\xd7\xa7\xd7\x9c\xd7\x99\xd7\x98\xd7\x94"
+
+    y1 = pdf.get_y
+    pdf.multi_cell(w, 0, txt)
+    pno = pdf.get_page
+    assert_equal pno, 1
+    y2 = pdf.get_y
+    h1 = y2 - y1
+
+    h2 = pdf.getStringHeight(w, txt)
+    assert_in_delta h1, h2, 0.01
+
+    line = pdf.get_num_lines(txt, w)
+    assert_equal line, 41
+  end
+
+  test "getStringHeight Minimum Bidi test 2" do
+    pdf = TCPDF.new('P', 'mm', 'A4', true, "UTF-8", true)
+    pdf.set_font('freesans', '')
+    pdf.set_rtl(true)
+    pdf.set_temp_rtl('R')
+    pdf.add_page
+
+    margins = pdf.get_margins
+    w = pdf.get_string_width('OO') + margins['cell'] * 2
+
+    txt =  "\xd7\x9c 000"
+
+    y1 = pdf.get_y
+    pdf.multi_cell(w, 0, txt)
+    pno = pdf.get_page
+    assert_equal pno, 1
+    y2 = pdf.get_y
+    h1 = y2 - y1
+
+    h2 = pdf.getStringHeight(w, txt)
+    assert_in_delta h1, h2, 0.01
+
+    line = pdf.get_num_lines(txt, w)
+    assert_equal line, 3
+  end
 end

data/test/tcpdf_image_test.rb

@@ -69,4 +69,40 @@ class TcpdfTest < ActiveSupport::TestCase
     }
     assert_equal( err.message, 'TCPDF error: Missing image file: foo.png')
   end
+
+  test "Image basic test" do
+    pdf = TCPDF.new
+    pdf.add_page
+    img_file = File.join(File.dirname(__FILE__), '..', 'logo_example.png')
+
+    result_img = pdf.image(img_file, 50, 0, 0, '', '', '', '', false, 300, '', true)
+
+    no = pdf.get_num_pages
+    assert_equal no, 1
+  end
+
+  test "Image fitonpage test 1" do
+    pdf = TCPDF.new
+    pdf.add_page
+    img_file = File.join(File.dirname(__FILE__), '..', 'logo_example.png')
+
+    result_img = pdf.image(img_file, 50, 140, 100, '', '', '', '', false, 300, '', true, false, 0, false, false, true)
+
+    no = pdf.get_num_pages
+    assert_equal no, 1
+  end
+
+  test "Image fitonpage test 2" do
+    pdf = TCPDF.new
+    pdf.add_page
+    img_file = File.join(File.dirname(__FILE__), '..', 'logo_example.png')
+
+    y = 100
+    w = pdf.get_page_width * 2
+    h = pdf.get_page_height
+    result_img = pdf.image(img_file, '', y, w, h, '', '', '', false, 300, '', true, false, 0, false, false, true)
+
+    no = pdf.get_num_pages
+    assert_equal no, 1
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfpdf
 version: !ruby/object:Gem::Version
-  version: 1.17.3
+  version: 1.17.4
 platform: ruby
 authors:
 - NAITOH Jun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -48,6 +48,7 @@ extra_rdoc_files: []
 files:
 - CHANGELOG
 - Gemfile
+- README.md
 - Rakefile
 - lib/core/rmagick.rb
 - lib/fonts/README.z