prawn_report 1.9.18

data/lib/report.rb

@@ -0,0 +1,190 @@
+#coding: utf-8
+
+require 'prawn'
+
+require File.expand_path(File.dirname(__FILE__) + "/report_helpers")
+require File.expand_path(File.dirname(__FILE__) + "/report_info")
+
+# This is the module for all classes in the prawn_report gem
+module PrawnReport
+  unless defined? DEFAULT_REPORT_PARAMS 
+    DEFAULT_REPORT_PARAMS = {:page_size => 'A4', :margin => [20, 20, 20, 20],
+      :page_layout => :portrait}
+    
+    LABEL_SIZE = 6
+    TEXT_SIZE = 10
+    
+    SECTION_SPACING = LABEL_SIZE + 4
+    
+    LINE_WIDTH = 0.3
+    
+    DEFAULT_FONT = 'Times-Roman'
+      
+    TEXT_BOX_RADIUS = 2
+    TEXT_BOX_HEIGTH = 20
+  end
+  
+  # Report is the base class for all reports, it encapsulates all logic for rendering
+  #   report parts.
+  class Report
+    attr_reader :pdf, :data, :max_width, :max_height, :totals, :group_totals
+    attr_accessor :header_class, :header_other_pages_class, :x, :report_params,
+      :running_totals
+    
+    def initialize(report_params)
+      @report_params = DEFAULT_REPORT_PARAMS.merge(report_params || {})
+      @running_totals = @report_params.delete(:running_totals) || []
+      @num_pages = 1
+      
+      @pdf = Prawn::Document.new(@report_params)
+        
+      @pdf.font(DEFAULT_FONT)
+      @pdf.line_width = LINE_WIDTH
+      
+      if @report_params[:page_size].is_a?(String)
+        if @report_params[:page_layout] == :portrait
+          w, h = *Prawn::Document::PageGeometry::SIZES[@report_params[:page_size]]
+        else
+          h, w = *Prawn::Document::PageGeometry::SIZES[@report_params[:page_size]]
+        end
+      else
+        w, h = @report_params[:page_size]
+      end
+      @x = 0
+      @y = @max_height = h - (@report_params[:margin][0] + @report_params[:margin][2])
+      @max_width = w - (@report_params[:margin][1] + @report_params[:margin][3])
+
+      @footer_size = 0
+      @pdf.move_cursor_to(max_height - @report_params[:margin][2])
+      
+      @header_class = @header_other_pages_class = @summary_band_class =  @footer_class = nil
+      @totals = {}
+      @group_totals = {}
+      
+      initialize_running_totals
+    end
+    
+    def params
+      @report_params
+    end
+    
+    def draw(data)
+      @data = data
+      
+      draw_header_first_page
+      draw_internal
+      draw_summary
+      draw_footer
+      
+      second_pass
+      
+      @pdf.close_and_stroke
+      @pdf.render
+    end
+    
+    def new_page(print_titles = true)
+      draw_footer
+      
+      @num_pages += 1
+      @pdf.start_new_page
+      @x = 0
+      @pdf.move_down(@report_params[:margin][0])
+      
+      draw_header_other_pages
+    end
+    
+    def fill_color(color)
+      @pdf.fill_color color
+        @pdf.fill_rectangle [x,y], max_width, 15
+        @pdf.fill_color '000000'
+    end    
+    
+    protected
+    
+    def draw_header_first_page
+      draw_header(@header_class)
+    end  
+      
+    def draw_header_other_pages
+      draw_header(@header_other_pages_class || @header_class)
+    end
+    
+    def draw_header(klass)
+      if klass
+        header = klass.new(self)
+        header.draw
+        @pdf.y = @max_height - header.height
+        @x = 0
+      end
+    end
+    
+    def draw_footer
+      if @footer_class
+        footer = @footer_class.new(self)
+        @pdf.move_cursor_to(@footer_class.height)
+        footer.draw
+      end
+    end
+    
+    def draw_summary
+      if @summary_class
+        summary = @summary_class.new(self)
+        summary.draw
+      end
+    end
+    
+    def draw_group_summary
+      if @report_params[:group] && @report_params[:group][:summary_class]
+        summary = @report_params[:group][:summary_class].new(self)
+        summary.draw
+      end
+    end
+
+    def draw_group_header
+      if @report_params[:group][:header_class]
+        header = @report_params[:group][:header_class].new(self)
+        header.draw
+      end
+    end
+
+    def second_pass
+    
+    end
+    
+    def run_totals(data_row)
+      @running_totals.each do |rt|
+        vl = get_raw_field_value(data_row, rt)
+	vl = (vl.is_a? (String) ? vl.to_f : vl)
+        @totals[rt] = (@totals[rt] || 0) + (vl == '' ? 0 : vl)
+        @group_totals[rt] = (@group_totals[rt] || 0) + (vl == '' ? 0 : vl)
+      end
+    end
+
+    def initialize_running_totals
+      @running_totals.each do |rt|
+        @totals[rt] = 0
+        @group_totals[rt] = 0
+      end
+    end
+
+    def reset_group_totals
+      @running_totals.each do |rt|
+        @group_totals[rt] = 0
+      end
+    end
+    
+    def reset_totals
+      @running_totals.each do |rt|
+        @totals[rt] = 0
+      end
+    end    
+    
+    def get_raw_field_value(row, column_name)
+      c = row
+      column_name.split('.').each {|n| c = c[n] if c}
+      c.nil? ? '' : c
+    end 
+    
+  end
+end  
+

data/lib/report_helpers.rb

@@ -0,0 +1,82 @@
+# coding: utf-8
+
+module PrawnReport
+  class Report
+      
+    def box(width, height, options = {})
+      @pdf.rounded_rectangle([0, y], width, height, TEXT_BOX_RADIUS)
+    end
+      
+    def text_box_with_box(label, text, width, height = nil, options = {})
+      @pdf.rounded_rectangle([@x, y], width, height || TEXT_BOX_HEIGTH, TEXT_BOX_RADIUS)
+      @pdf.text_box(label, :size => LABEL_SIZE, :at => [@x + 2, y - 2], :width => width - 2,
+          :height => LABEL_SIZE, :valign => :top)
+      h_text = height.nil? ? TEXT_SIZE : height - LABEL_SIZE - 4
+      @pdf.text_box(text || '', { :size => TEXT_SIZE, :at => [@x + 2, y - LABEL_SIZE - 4],
+          :width => width - 2, :height => h_text, :valign => :top }.merge(options))
+      @x += width  
+    end
+    
+    def text(text, width, options = {})
+      font_size = options[:font_size] || TEXT_SIZE
+      @pdf.text_box(text, :size => font_size, :style => options[:style], :at => [@x, y - 4],
+            :width => width, :height => font_size, 
+            :valign => (options[:valign] || :top),
+            :align => (options[:align] || :left)
+            )
+      @x = @x + width
+    end
+    
+    def horizontal_line(x_ini = 0, x_end = @max_width)
+      @pdf.stroke do
+        @pdf.horizontal_line(x_ini, x_end, :at => y)
+      end
+    end
+    
+    def y
+      @pdf.y
+    end
+    
+    def y=(y)
+      @pdf.y = y
+    end    
+    
+    def space(width)
+      @x += width
+    end
+    
+    def line_break(size = TEXT_SIZE)
+      @x = 0
+      @pdf.move_down(@pdf.height_of('A', :size => size) + 2)
+    end
+  
+    def format(value, formatter, options = {})
+      if !value.nil? && value != ''
+        if (formatter == :currency)
+          if value < 0
+            '-'+((value.to_i*-1).to_s.reverse.gsub(/...(?=.)/,'\&.').reverse) + ',' + ('%02d' % ((value.abs * 100).round % 100))
+          else
+            (value.to_i.to_s.reverse.gsub(/...(?=.)/,'\&.').reverse) + ',' + ('%02d' % ((value * 100).round % 100))
+          end
+        elsif (formatter == :date)
+          value.to_time.strftime('%d/%m/%Y')
+        elsif (formatter == :timezone_date)
+          tz = Time.zone.parse(value)
+          tz.nil? ? '' : tz.strftime('%d/%m/%Y')
+        elsif (formatter == :function)
+          send(options[:formatter_function].to_s, value)          
+        else
+          value.to_s
+        end
+      else
+        ''
+      end
+    end
+    
+    def draw_graph(g, params)
+      data = StringIO.new(g.to_blob)
+      @pdf.image(data, params)
+    end
+
+  end
+end

data/lib/report_info.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+require 'date'
+
+module PrawnReport
+  class Report
+    
+    attr_accessor :force_today_as
+
+    def fits?(h)
+      (y - footer_size - h - @report_params[:margin][2]) >= 0 
+    end
+    
+    def header_size
+      @header ? @header_class.height : 0
+    end
+
+    def footer_size
+      @footer_class ? @footer_class.height : 0
+    end
+    
+    def today
+      @force_today_as ? @force_today_as : Date.today
+    end
+ 
+  end
+end

data/repo/bands/footers/footer_001.rb

@@ -0,0 +1,20 @@
+#coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + "/../../../lib/bands/footer_band")
+
+module PrawnReport
+
+  class Footer001 < FooterBand
+
+    def internal_draw
+      report.horizontal_line
+      report.x = 0
+    end
+    
+    def self.height
+      10
+    end
+    
+  end
+  
+end

data/repo/bands/headers/header_001.rb

@@ -0,0 +1,61 @@
+#coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + "/../../../lib/bands/header_band")
+
+module PrawnReport
+
+  #This header renders:
+  #
+  #* Company name based on a property at the root of data named +company_name+  left aligned
+  #  font size 16.
+  #* Data de emissão dated today right aligned font size 12
+  #* Report name based on a parameter named +report_name+ setted in the report
+  #* A list of filters read from *report.params[:filters]*. Each filter is printed in one
+  #  line. *params[:filters]* must be an array of arrays where the inner arrays must be
+  #  tuples of two elements, the first one being the title and second one being the value of the 
+  #  filter. If value is present the title is concatenated with ':'
+  class Header001 < HeaderBand
+    
+    def initialize(report, params = {})
+      super(report, params)
+      @filter_size = 0
+    end
+    
+    def internal_draw            
+      report.text(report.data['company_name'], 300, :style => :bold, :font_size => 16)
+      txt_emissao = 'Data de emissão: ' + report.today.strftime('%d/%m/%Y')
+      length = report.pdf.width_of(txt_emissao, :size => 12)
+      report.x = report.max_width - length
+      report.text(txt_emissao, length, :font_size => 12, 
+        :valign => :bottom, :align => :right)
+      report.line_break(16)
+      report.text(report.params[:report_name], report.max_width, :font_size => 13, 
+         :align => :center)
+      report.line_break(13)
+      draw_filters if report.params[:filters]
+      report.horizontal_line
+    end
+    
+    def draw_filters      
+      report.params[:filters].each do |param|
+        title = param[0]
+        if param[1].to_s != ''
+          title = title + ':'
+        end
+        report.text(title, 2 + report.pdf.width_of(title, :size => 10), :font_size => 10)
+        report.text(param[1], 2 + report.pdf.width_of(param[1], :size => 10), :font_size => 10)
+        report.x = 0
+        size = report.pdf.height_of(param[1], :size => 10)
+        size = 10 if size < 10
+        report.pdf.move_down(size + 2)
+        @filter_size += size + 2
+      end
+    end
+    
+    def height      
+      45 + @filter_size
+    end
+        
+  end
+  
+end

data/repo/bands/headers/header_002.rb

@@ -0,0 +1,31 @@
+#coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + "/../../../lib/bands/header_band")
+
+module PrawnReport
+  #This is a minimalist header intended to render the company name and report name in additional
+  #pages of a report.
+  #
+  #This header renders:
+  #
+  #* Company name based on a property at the root of data named +company_name+  left aligned
+  #  font size 12.
+  #* Report name based on a parameter named +report_name+ setted in the report
+  class Header002 < HeaderBand
+    
+    def internal_draw
+      report.x = 0
+      report.text(report.data['company_name'], 300, :font_size => 12)
+      report.x = 0
+      report.text(report.params[:report_name], report.max_width, :font_size => 12, :align => :right)
+      report.line_break(12)
+      report.horizontal_line
+    end
+    
+    def height
+      20
+    end
+    
+  end
+  
+end

data/repo/reports/column_group.rb

@@ -0,0 +1,58 @@
+module PrawnReport
+  class NoGroupingFieldProvided < Exception; end
+  class NoGroupingValueFieldProvided < Exception; end
+  class NoGroupingContextFieldProvided < Exception; end
+
+  class ColumnGroup < Listing
+    attr_accessor :grouping_field
+    attr_accessor :grouping_context_field
+    attr_accessor :grouping_value_field
+
+    def new_page(print_titles = true)
+      draw_column_titles if print_titles
+    end
+
+    def before_draw_lines
+      super
+      draw_column_titles
+    end
+
+    def initialize(report_params = {})
+      super(report_params)
+      raise NoGroupingFieldProvided unless report_params[:grouping_field]
+      raise NoGroupingValueFieldProvided unless report_params[:grouping_value_field]
+      raise NoGroupingContextFieldProvided unless report_params[:grouping_context_field]
+      @grouping_field = report_params[:grouping_field]
+      @grouping_value_field = report_params[:grouping_value_field]
+      @grouping_context_field = report_params[:grouping_context_field]
+    end
+
+    def draw(data)
+      data = traverse_data(data)
+      super(data)
+    end
+
+    protected
+
+    def traverse_data(data)
+      new_data = []
+      last_value = nil
+      new_row = nil
+      old_data = data[@detail_name]
+      old_data.each do |row|
+        if row[@grouping_field] != last_value then
+          new_data << new_row unless new_row.nil?
+          last_value = row[@grouping_field]
+          new_row = {}
+          row.each_pair {|k,v| new_row[k] = v}
+        end
+        new_row[@grouping_context_field.to_s + '_' + row[@grouping_context_field].to_s] = row[@grouping_value_field]
+      end
+      new_data << new_row unless new_row.nil?
+      data[@detail_name]=new_data
+      data
+    end
+
+
+  end
+end