pdf_gen 0.7

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010, Sphere Consutling Inc.
+
+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.rdoc

@@ -0,0 +1,189 @@
+== Pdf_gen
+pdf_gen is a high-level wrapper around {PDF::Writer}[https://github.com/sandal/pdf-writer] library which allows to create PDF documents in an easy way with a layout similar to HTML.
+
+== Install
+  gem install pdf_gen
+
+== Usage
+All package entities are located within the PDFGen module.
+PDF file generation can be made in the following way:
+
+  require "pdf_gen"
+
+  PDFGen::document PDF::Writer.new, 0.cm do
+    # pdf generation code here
+  end.save("#{File.basename(__FILE__, ".rb")}.pdf")
+
+== Construction Elements
+
+=== Caption
+An object which allows to represent some parts of the text in PDF file. This object has such properties as width, justification, pad_top (indent from the left side of the page), pad_bottom, pad_left, pad_right, text_color, font_size and border.
+The Border, in its turn, can be characterized by border_color, border_style (solid or dotted) and border_width (in cm or pixels).
+Support Properties:
+  pad_top - integer
+  pad_bottom - integer
+  pad_left - integer
+  pad_right - integer
+  paddings - integer
+  border - true|false
+  border_top - true|false
+  border_bottom - true|false
+  border_left - true|false
+  border_right - true|false
+  border_style - :solid | :dotted
+  border_widht - integer
+  border_color - object of color-tools*. Color::RGB::Red|Color::RGB.from_html("#ccc")| other
+  background_color - object of color-tools*. Color::RGB::Red|Color::RGB.from_html("#ccc")| other
+  width - integer
+  height - integer
+  
+  *color-tools http://ruby-pdf.rubyforge.org/color-tools/
+
+=== Image
+An object which allows to add images with filename extensions *.jpg and *.png in PDF file. This object has such properties as width, pad_top, pad_bottom, pad_left, pad_right and border.
+
+  require "pdf_gen"
+
+  PDFGen::document PDF::Writer.new, 2.cm do
+    image_data = open(File.expand_path('ruby_logo.jpg'), "rb") { |file| file.read }
+    image image_data, :width => 250
+  end.save("#{File.basename(__FILE__, ".rb")}.pdf")
+  
+Support Properties:
+  *the same as caption`s properties
+  
+=== Span
+An object which allows setting several objects across the page. This object has such properties as width, pad_top, pad_bottom, pad_left, pad_right, border and background_color.
+
+  PDFGen::document PDF::Writer.new, 2.cm do
+    span :width => 10.cm, :pad_left => 2.cm do
+      caption ' first '*50, :width => 4.cm
+      caption ' second '*50, :width => 4.cm
+      elements :border => true    #group set params
+    end
+  end.save("#{File.basename(__FILE__, ".rb")}.pdf")
+  
+Support Properties:
+  *the same as caption`s properties
+  vertical_interval - integer
+  vartical_align - true | false
+  
+=== Div
+An object which allows setting several elements in the vertical format. This object has such properties as width, horizontal_interval, pad_top, pad_bottom, pad_left, pad_right, border and background_color.
+
+  PDFGen::document PDF::Writer.new, 2.cm do
+    div :width => 10.cm do
+      caption ' first '*50, :width => 4.cm
+      caption ' second '*50, :width => 4.cm
+      elements :border => true    #group set params
+    end
+  end.save("#{File.basename(__FILE__, ".rb")}.pdf")
+  
+Support Properties:
+  *the same as caption`s properties
+  horizontal_interval - integer
+  horizontal_align - true | false
+
+=== Table
+An object which allows creating tables in PDF file. This object has such elements as title, header, body and footer. The columns can be made be adding “spans” inside the body of the table. The table can have borders from specific sides, for example: “:border_right => true” or “:border_right => false”.
+
+  require "pdf_gen"
+
+  PDFGen::document PDF::Writer.new, 0.cm do
+    table do
+      title do
+         caption "Transactions and Triggers",
+       :text_color => Color::RGB::Red, :border => true, :justification => :center, :pad_bottom => 0.25.cm
+      end
+      header do
+        span do
+          caption "Number",
+                  :width => av_width / 2, :justification => :center, :border => true
+          caption "Discription",
+                  :width => av_width / 2, :justification => :center, :border => true
+        end
+      end
+      body do
+        span do
+          caption "  Trigger ", :width => av_width / 2,
+                  :border_right => true, :border_left => true, :text_color => Color::RGB::Grey
+          caption " - is a ... ", :width => av_width / 2,
+                  :border_right => true, :border_left => true, :text_color => Color::RGB::Grey
+        end
+      end
+      footer do
+        span do
+          caption "1", :width => av_width / 2, :justification => :center, :border => true
+          caption "2", :width => av_width / 2, :justification => :center, :border => true
+        end
+      end
+    end
+  end.save("#{File.basename(__FILE__, ".rb")}.pdf")
+
+=== Smart Table
+An object which allows creating tables from Hash and ActiveRecord. If necessary, you can define the blocks of the title and footer independently.
+For example:
+
+  table_data = {:columns =>['id','name','email'],
+                :body => [[1,'Valeriy','valeriy@example.com'],
+                          [2,'Dmitriy','dmitriy@example.com']]}
+  PDFGen::document PDF::Writer.new, 0.cm do
+    div :paddings => 2 do
+      table :data_source => table_data
+    end
+  end.save("#{File.basename(__FILE__, ".rb")}.pdf")
+
+Building a table from ActiveRecord (ROR)
+
+  table_data = User.all
+  PDFGen::document PDF::Writer.new, 0.cm do
+    div :paddings => 2 do
+      table :data_source => table_data
+    end
+  end.save("#{File.basename(__FILE__, ".rb")}.pdf")
+
+Custom view
+
+  table_data = {:columns =>['id','name','email'],
+                :body => [[1,'Valeriy','valeriy@example.com'],
+                          [2,'Dmitriy','dmitriy@example.com']]}
+  PDFGen::document PDF::Writer.new, 0.cm do
+    div :paddings => 2 do
+      table :data_source => table_data do
+         header do
+           row do
+             cell "<b>#{ds.columns[0]}</b>", :justification => :center, :text_color => Color::RGB::Green
+             cell ds.columns[1], :justification => :center, :text_color => Color::RGB::Green
+             cell ds.columns[2], :justification => :center, :text_color => Color::RGB::Green           
+           end
+         end
+         body do
+           ds.each do |datarow|
+             row do
+               cell datarow[0]
+               cell "<i>#{datarow[1]}</i>"
+               cell datarow[2]
+             end
+           end
+         end
+      end
+    end
+  end.save("#{File.basename(__FILE__, ".rb")}.pdf")
+
+We can set the width of each column
+
+  row do
+    cell data[0], :width => av_width * 2/4
+    cell data[1], :width => av_width * 1/4
+    cell data[2], :width => av_width * 1/4
+  end
+
+
+== Credits
+
+=== Team's line-up
+* Mykhaylo Sorochan, Valeriy Prokopchuk - Project Managers
+* Valeriy Sizov, Dmitriy Landberg - Software Developers
+* Nataliya Shatokhina - Tester
+
+Copyright (c) 2010 {Sphere Consulting Inc.}[http://www.sphereinc.com], released under the MIT license (see LICENSE).

data/lib/base_region.rb

@@ -0,0 +1,95 @@
+require "lib/modules/base_attributes"
+
+module PDFGen
+
+  class BaseRegion
+    include BaseAttributes
+    
+    def initialize(parent)
+      self.var_init
+      @parent = parent
+    end
+
+    attr_reader :parent
+    
+    #gets region's document
+    def document
+      parent ? parent.document : self
+    end
+
+    #gets minimal height that current caption can be written to
+    def minimal_height
+      @minimal_height ||= calculate_minimal_height
+    end
+
+    def clear_minimal_height
+      @minimal_height = nil
+    end
+
+    protected :clear_minimal_height
+
+    def calculate_minimal_height
+      0
+    end
+
+    protected :calculate_minimal_height
+
+    def add_border(pos)
+      x,y = pos
+      if border_top || border_bottom || border_left || border_right
+        document.pdf.save_state
+
+        document.pdf.stroke_color! border_color
+        document.pdf.stroke_style! border_params
+
+        document.pdf.line(x, y, x, y - height).stroke if border_left
+        document.pdf.line(x + width, y, x + width, y - height).stroke if border_right
+        document.pdf.line(x, y, x + width, y).stroke if border_top
+        document.pdf.line(x, y - height, x + width, y - height).stroke if border_bottom
+
+        document.pdf.restore_state
+      end
+    end
+
+    private :add_border
+
+    #fills caption area with background color
+    def fill(pos)
+      unless background_color.nil?
+        document.pdf.save_state
+
+        document.pdf.stroke_color! background_color
+        document.pdf.stroke_style! PDF::Writer::StrokeStyle::SOLID
+        document.pdf.fill_color! background_color
+        document.pdf.rectangle(pos[0], pos[1] - height, width, height).fill.stroke
+
+        document.pdf.restore_state
+      end
+    end
+
+    private :fill
+
+    def render(pos,av_height, test=false)
+      fill(pos) unless test
+      add_border(pos) unless test
+      [pos,true]
+    end
+    
+    def check_fit_in_height
+      if (self.height >= document.pdf.page_height-document.page_pad_top)
+        raise "region`s height is bigger then parent region`s height"
+      end
+    end
+        
+    def value val
+      "<!#{val.to_s}!>"
+    end
+
+    #sets region properties specified as array
+    def set_properties(props = {})
+      props.each_pair {|name, value| self.send("#{name}=", value)}
+    end
+    
+  end
+  
+end

data/lib/caption.rb

@@ -0,0 +1,78 @@
+require "lib/base_region"
+
+
+module PDFGen
+  
+  class Caption < BaseRegion
+   
+    def initialize(parent)
+      super
+
+      @text = ""
+      @template = @text
+      @justification = :left
+      @bold = false
+      @font_size = document.pdf.font_size
+      self.paddings = 0.2.cm
+      end
+    
+    attr_reader :text
+
+    def text=(value)
+      value = value.to_s unless value.is_a?(String)
+      if value && @text != value
+        @text = value
+        @template = value
+        clear_minimal_height
+      end
+    end
+
+    attr_reader :text_color, :justification, :bold, :font_size
+
+    common_setter :text_color, :justification, :bold, :font_size
+
+    def calculate_minimal_height
+      add_text_wrap
+    end
+
+    #writes text. return actual text height
+    def add_text_wrap(pos=[], test = true)
+      x = pos[0] || 0
+      y = pos[1] || document.pdf.y
+      
+      res = document.pdf.font_height + pad_top
+      txt = bold ? "<b>#{text}</b>" : text
+      
+      document.pdf.save_state
+      document.pdf.fill_color text_color if text_color
+      document.pdf.stroke_color! text_color if text_color
+      until (txt_remain = document.pdf.add_text_wrap(x + pad_left, y - res, width - pad_left - pad_right, txt, font_size,
+                justification, 0, test)).empty?
+        txt_remain == txt ? raise("text very long for this caption") : txt = txt_remain
+        res += document.pdf.font_height(font_size)
+      end
+      document.pdf.restore_state
+
+      res + pad_bottom
+    end
+
+    private :add_text_wrap
+
+    #renders specified text at the specified position
+    #returns real position that caption was generated on
+    def render(pos, av_height, test=false)
+      self.check_fit_in_height
+      if av_height >= self.height 
+        super
+        add_text_wrap(pos,test)
+        used_height = [add_text_wrap(pos),self.height].max
+        [used_height, true]
+      else
+        [0, false]
+      end
+    end
+
+  end
+
+end
+

data/lib/containers/caption_container.rb

@@ -0,0 +1,15 @@
+module PDFGen
+
+  module CaptionContainer
+
+    def caption(text = nil, style = nil)
+      caption = Caption.new self
+      caption.text = text if text
+      caption.width = self.width - self.pad_left - self.pad_right
+      caption.set_properties style unless style.nil?
+      self.add_region(caption)
+    end
+
+  end
+  
+end

data/lib/containers/div_container.rb

@@ -0,0 +1,14 @@
+module PDFGen
+
+  module DivContainer
+
+    def div(style = nil, &initialization_block)
+      div = Div.new(self)
+      div.width = self.width - self.pad_left - self.pad_right
+      div.set_properties style unless style.nil?
+      div.instance_eval(&initialization_block) if initialization_block
+      self.add_region(div)
+    end
+
+  end
+end

data/lib/containers/image_container.rb

@@ -0,0 +1,15 @@
+require "lib/image"
+module PDFGen
+
+
+module ImageContainer
+
+    def image(image_res, style=nil)
+      image = Image.new self, image_res
+      image.set_properties style unless style.nil?
+      self.add_region(image)
+    end
+
+  end
+  
+end

data/lib/containers/span_container.rb

@@ -0,0 +1,14 @@
+module PDFGen
+
+  module SpanContainer
+
+    def span(style = nil, &initialization_block)
+      span = Span.new self
+      span.width = self.width - self.pad_left - self.pad_right
+      span.set_properties style unless style.nil?
+      span.instance_eval(&initialization_block) if initialization_block
+      self.add_region(span)
+    end
+
+  end
+end

data/lib/containers/table_container.rb

@@ -0,0 +1,14 @@
+module PDFGen
+
+  module TableContainer
+
+    def table(style = nil, &initialization_block)
+      table = (style.is_a?(Hash) and style.has_key?(:data_source)) ?
+              SmartTable.new(self) : Table.new(self)
+      table.set_properties style unless style.nil?
+      table.instance_eval(&initialization_block) if initialization_block
+      self.add_region(table)
+    end
+
+  end
+end

data/lib/data/ds_ar.rb

@@ -0,0 +1,31 @@
+require "lib/data/ds_base"
+
+module PDFGen
+  
+  class DsActiveRecord < DsBase
+    def initialize(data)
+      @data = data
+    end
+
+    def columns
+      @data.first.class.columns.map(&:name)
+    end
+
+    def body
+      @fields = []
+      @data.each do |row|
+        @mas = []
+        columns.each do |title|
+          @mas << row.send(title)
+        end
+        @fields << @mas
+      end
+      @fields
+    end
+
+    def each
+      self.body.each {|item| yield item}
+    end
+  end
+
+end

data/lib/data/ds_base.rb

@@ -0,0 +1,24 @@
+module PDFGen
+
+  class DsBase
+    
+    include Enumerable
+    
+    def initialize(data)
+      raise "Not Implemented"
+    end
+
+    def columns
+      raise "Not Implemented"
+    end
+
+    def body
+      raise "Not Implemented"
+    end
+
+    def each
+      raise "Not Implemented"
+    end
+  end
+
+end

data/lib/data/ds_hash.rb

@@ -0,0 +1,24 @@
+require "lib/data/ds_base"
+
+
+module PDFGen
+
+  class DsHash < DsBase
+    def initialize(data)
+      @data = data
+    end
+
+    def columns
+      @data[:columns]
+    end
+
+    def body
+      @data[:body]
+    end
+
+    def each
+      self.body.each {|item| yield item}
+    end
+  end
+
+end

data/lib/div.rb

@@ -0,0 +1,148 @@
+require "lib/base_region"
+require "lib/modules/composite"
+require "lib/containers/div_container"
+require "lib/containers/span_container"
+require "lib/containers/caption_container"
+require "lib/containers/image_container"
+require "lib/containers/table_container"
+
+
+module PDFGen
+
+  class Div < BaseRegion
+
+    include Composite, CaptionContainer, SpanContainer, DivContainer,
+            ImageContainer, TableContainer
+
+    def initialize parent
+      super
+
+      @horizontal_interval = 0
+      @horizontal_align = false
+      @optional_border = false
+      @is_breakable = true
+      @count_rendered_region = 0
+      @rendered_height = 0
+    end
+
+    attr_accessor :horizontal_interval, :horizontal_align, :optional_border
+    attr_accessor :count_rendered_region
+
+    def add_border_top(x, y)
+      add_border(x, y, x + width, y) if border_top
+    end
+
+    def add_border_bottom(x, y)
+      add_border(x, y, x + width, y) if border_bottom
+    end
+
+    #border left and right
+    def add_border_sides(x, y, y_new)
+      add_border(x, y, x, y_new) if border_left
+      add_border(x + width, y, x + width, y_new) if border_right
+    end
+
+    def add_border(x, y, x1, y1)
+      document.pdf.save_state
+      document.pdf.stroke_color! border_color
+      document.pdf.stroke_style! border_params
+      document.pdf.line(x, y, x1, y1).stroke
+      document.pdf.restore_state
+    end
+
+    def add_optional_border(x, y)
+      add_border(x, y, x + width, y)
+    end
+
+    def calculate_minimal_height
+      height = 0
+      regions.each do |region|
+        height += region.height
+        height += horizontal_interval unless region == regions.last
+      end
+      height + pad_top + pad_bottom
+    end
+
+    def render_regions(pos, av_height, test=false)
+      pos_x, pos_y = pos
+      remain_regions = regions.slice(@count_rendered_region..regions.size)
+      if @count_rendered_region.zero? && @rendered_height.zero?
+        @rendered_height += pad_top
+        pos_y -= pad_top
+      end
+      pos_x += pad_left
+     
+      remain_regions.each do |region|
+        self.fit_width(region)
+        if pos_y >= region.height
+          @count_rendered_region += 1 unless test
+          
+          region_height = region.render([pos_x, pos_y], pos_y, test)[0]
+
+          @rendered_height += region_height
+          pos_y -= region_height
+
+          @rendered_height += horizontal_interval unless region == regions.last
+          pos_y -= horizontal_interval unless region == regions.last
+
+          if region == regions.last
+            pos_y -= pad_bottom
+            @rendered_height += pad_bottom
+          end
+        else
+          if region.breakable?
+            status = region.render([pos_x, pos_y], pos_y, test)
+
+            @rendered_height += status[0]
+            pos_y -= status[0]
+
+            @rendered_height += horizontal_interval unless region == regions.last
+            pos_y -= horizontal_interval unless region == regions.last
+
+            if region == regions.last and status[1]
+              pos_y -= pad_bottom
+              @rendered_height += pad_bottom
+            end
+
+            return [av_height - pos_y, status[1]]
+          else
+            region.check_fit_in_height
+            return [av_height - pos_y, false]
+          end
+        end
+      end
+
+      [av_height - pos_y, true]
+    end
+
+    def render(pos, av_height, test=false)
+      pos_x, pos_y = pos
+      fill(pos)
+      add_border_top(pos_x, pos_y) if @rendered_height.zero?      
+      status = render_regions([pos_x, pos_y], av_height, test)
+      pos_y -= status[0]
+
+      if (status[1])
+        add_border_bottom(pos_x, pos_y)
+        add_border_sides(pos_x, av_height, pos_y)
+      else
+        add_border_sides(pos_x, av_height, 0)
+      end
+
+      status
+    end
+
+    def fit_width(region)
+      if (region.width > (width - pad_left - pad_right)) or horizontal_align
+        region.width = width - pad_left - pad_right
+      end
+    end
+
+    protected :fit_width
+
+    def reset_count_rendered_regions
+      @count_rendered_region = 0
+    end
+  end
+
+end