prawn_report 1.9.18

data/repo/reports/listing.rb

@@ -0,0 +1,144 @@
+#coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/report.rb")
+require File.expand_path(File.dirname(__FILE__) + "/../bands/headers/header_001.rb")
+require File.expand_path(File.dirname(__FILE__) + "/../bands/headers/header_002.rb")
+require File.expand_path(File.dirname(__FILE__) + "/../bands/footers/footer_001.rb")
+
+module PrawnReport
+  class Listing < Report
+
+    alias :super_new_page :new_page
+
+    def initialize(report_params = {})
+      super(report_params)
+      @header_class = PrawnReport::Header001
+      @header_other_pages_class = PrawnReport::Header002
+      @footer_class = PrawnReport::Footer001
+      @filling_colors = ['cccccc', 'ffffff'].cycle
+      @current_row = nil
+      @printing_internal = false
+      @data_end = false
+      @detail_name = @report_params[:detail_name] || 'items'
+    end
+
+    #Override line_height to calculate the proper line height for the record
+    #The current record can be accessed via the property @current_row
+    def line_height
+      15
+    end
+
+    def before_draw_lines
+      @printing_internal = true
+      @data_end = false
+    end
+
+    def after_draw_lines
+      @data_end = true
+      @printing_internal = false
+    end
+
+    def before_render_line
+      new_page unless fits?(line_height)
+      @x = 0
+    end
+
+    def after_render_line
+      line_break(line_height-4)
+      run_totals(@current_row)
+    end
+
+    def draw_lines
+      @data[@detail_name].each do |row|
+        @current_row = row
+        before_render_line
+        render_line(@current_row)
+        after_render_line
+      end
+    end
+
+    def draw_internal
+      before_draw_lines if defined? before_draw_lines
+      draw_lines if defined? 'draw_lines'
+      after_draw_lines if defined? after_draw_lines
+    end
+
+    def render_line(row)
+      @pdf.fill_color @filling_colors.next
+      @pdf.fill_rectangle [x,y], max_width, line_height
+      @pdf.fill_color '000000'
+
+      if @report_params[:field]
+        render_one_column_line(row)
+      elsif @report_params[:columns]
+        render_multi_column_line(row)
+      end
+    end
+
+    def  render_one_column_title
+      if @report_params[:title]
+        text(@report_params[:title], @max_width, :font_size => 12, :style => :bold)
+        line_break(13)
+      end
+    end
+
+    def render_multi_column_title
+      @report_params[:columns].each do |c|
+        unless c[:formatter] == :invisible
+          width = c[:width] || 60
+          align = c[:align] || :left
+          text(c[:title].to_s, width, :font_size => c[:font_size] || 12, :style => :bold, :align => align)
+          space(3)
+        end
+      end
+      line_break(13)
+    end
+
+    def render_one_column_line(row)
+      text(row[@report_params[:field]], 100, :font_size => 12)
+    end
+
+    def render_multi_column_line(row)
+      @report_params[:columns].each do |c|
+        unless c[:formatter] == :invisible
+          width = c[:width] || 60
+          formatter = c[:formatter] || :none
+          raw_value = get_raw_field_value(row, c[:name].to_s)
+          formatter_options = build_formatter_options(formatter, c)
+          formatted_text = format(raw_value, formatter, formatter_options)
+          align = c[:align] || :left
+          font_size = c[:font_size] || 12
+          text(formatted_text, width, :font_size => font_size, :align => align)
+          space(3)
+        end
+      end
+    end
+
+    #This function will build the options to be passed to the specific formatter
+    def build_formatter_options(formatter, column_def)
+      r = {}
+      if formatter == :function
+        r[:formatter_function] = column_def[:formatter_function]
+      end
+      r
+    end
+
+    def second_pass
+      1.upto(@num_pages) do |i|
+        @pdf.go_to_page(i)
+        @pdf.move_cursor_to(10)
+        @x = 0
+        text("Página #{@pdf.page_number}/#{@pdf.page_count}", @max_width, :align => :right)
+      end
+    end
+
+    def draw_column_titles
+      new_page(false) unless fits?(30)
+      if @report_params[:field]
+        render_one_column_title
+      elsif @report_params[:columns]
+        render_multi_column_title
+      end
+    end
+  end
+end

data/repo/reports/simple_listing.rb

@@ -0,0 +1,130 @@
+#coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + "/listing.rb")
+
+module PrawnReport
+  #Generates a listing report with or without multiple columns.
+  #
+  #==Creating a SimpleListing Report
+  #To create a simple listing report you must inherit from PrawnReport::SimpleListing class
+  #and fill some parameters. The +report_name+ parameter is mandatory. The other parameters depends
+  #if you want a single or multi column listing.
+  #
+  #The parameters are filled setting the instance variable +params+ hash in initialize after calling
+  #super.
+  #
+  #==Single column listing
+  #For single column listings you must fill the +field+ parameter and, optionally, the +title+
+  #parameter. Like the code bellow
+  #  class ProductTypeListing < PrawnReport::SimpleListing
+  #    def initialize
+  #      super
+  #      @report_params = {
+  #        :report_name => 'Product Type Listing', 
+  #        :field => 'name',
+  #        :title => 'Name'
+  #      }
+  #    end
+  #  end
+  #
+  #==Multiple column listing
+  #To have a multiple column listing you must fill the +columns+ hash inside +params+ hash. Each column
+  #has the following properties:
+  #* +name+: The name of the field
+  #* +title+: The title to be rendered above the first row
+  #* +width+: The width of the column. Default value is 60
+  #
+  #The code belloow shows a listing of people with 3 columns
+  #
+  #  class PeopleListing < PrawnReport::SimpleListing
+  #    def initialize
+  #      super
+  #      @report_params = {
+  #        :report_name => 'People Listing', 
+  #        :columns => [
+  #          {:name => 'name', :title => 'Name', :width => 200},
+  #          {:name => 'age', :title => 'Age', :width => 30},
+  #          {:name => 'phone_number', :title => 'Phone #', :width => 100}
+  #        ]
+  #      }
+  #    end
+  #  end
+  #
+  #==Default behaviour
+  #The listing bellow shows the default behaviour of this class. This is not changeable at this
+  #momment. Any of this behaviour can become changeable in future versions of this gem.
+  #
+  #* Font: size 12. normal. Times-Roman
+  #* Row background color: Alternate between white and gray (cccccc)
+  #* First page Header class: PrawnReport::Header001
+  #* Other pages Header class: PrawnReport::Header002
+  #* Footer class: PrawnReport::Footer001
+
+
+  class SimpleListing < Listing
+
+    attr_reader :grouping_info
+    
+    def initialize(report_params = {})
+      super(report_params)
+      @grouping_info = {:last_group_value => nil,
+                        :groups_running => false}
+    end
+    
+    def new_page(print_titles = true)
+      super(print_titles)
+      draw_group_header if grouped? and @report_params[:group][:header_reprint_new_page] and !last_group_summary?
+      if print_titles
+        draw_column_titles unless (!draw_group_column_titles? && !@printing_internal) || last_group_summary?
+      end
+    end    
+
+    protected
+
+    def run_groups(row)
+      group_value = get_raw_field_value(row, params[:group][:field])
+      start_new_group = !@grouping_info[:groups_running]
+      start_new_group |=  group_value != @grouping_info[:last_group_value]
+      if start_new_group
+        if(@grouping_info[:groups_running] &&
+                     @grouping_info[:last_group_value] != group_value)
+          draw_group_summary
+          new_page(false) if params[:group][:new_page]
+        end
+        @grouping_info[:last_group_value] = group_value
+        @grouping_info[:groups_running] = true
+        draw_group_header
+        draw_column_titles if draw_group_column_titles?
+        reset_group_totals
+      end
+    end
+
+    def grouped?
+      params[:group]
+    end
+
+    def draw_group_column_titles?
+      ( params[:group].nil? ? false : (params[:group][:print_group_column_title].nil? ? true :
+          params[:group][:print_group_column_title]))
+    end
+
+    def last_group_summary?
+      @data_end
+    end
+
+    def before_draw_lines
+      super
+      draw_column_titles unless draw_group_column_titles?
+    end
+
+    def after_draw_lines
+      draw_group_summary if @data[@detail_name].count > 0
+    end
+
+    def before_render_line
+      super
+      run_groups(@current_row) if grouped?
+    end
+
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: prawn_report
+version: !ruby/object:Gem::Version
+  version: 1.9.18
+platform: ruby
+authors:
+- Ricardo Acras
+- Egon Hilgenstieler
+- Juliano Andrade
+- Wellington Torrejais
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-26 00:00:00.000000000 Z
+dependencies: []
+description: Prawn report is a class repository wich uses prawn gem capabilities to
+  generate PDF documents in order to make it easy to create real life reports.
+email: ricardo@acras.com.br julianoch@gmail.com egon@acras.com.br wtds.trabalho@gmail.com
+  desenv2@labplus.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/ac_filter_defs_controller.rb
+- app/controllers/custom_generate_report_controller.rb
+- app/controllers/generate_report_controller.rb
+- app/controllers/report_templates_controller.rb
+- app/models/ac_filter.rb
+- app/models/ac_filter_def.rb
+- app/models/ac_filter_option.rb
+- app/models/report_template.rb
+- lib/ac_filters_utils.rb
+- lib/active_record_helpers.rb
+- lib/bands/band.rb
+- lib/bands/footer_band.rb
+- lib/bands/header_band.rb
+- lib/bands/summary_band.rb
+- lib/custom_report_controller.rb
+- lib/generators/prawn_report/install/install_generator.rb
+- lib/generators/prawn_report/install/templates/20120108210141_create_prawn_report_catalogs.rb
+- lib/generators/prawn_report/install/templates/20120124012653_add_filter_defs.rb
+- lib/generators/prawn_report/install/templates/20120209231821_add_filters_to_reports.rb
+- lib/generators/prawn_report/install/templates/20120222021437_add_order_to_filter_def.rb
+- lib/generators/prawn_report/install/templates/20120222025632_add_select_sql.rb
+- lib/generators/prawn_report/install/templates/20120222030526_create_ac_filter_joins.rb
+- lib/generators/prawn_report/install/templates/20120222122507_add_serialization_params_to_report.rb
+- lib/generators/prawn_report/install/templates/20120222134101_create_ac_filter_includes.rb
+- lib/generators/prawn_report/install/templates/20120222150029_change_includes_and_joins_to_hash.rb
+- lib/generators/prawn_report/install/templates/20120229134810_add_group_to_filter_def.rb
+- lib/generators/prawn_report/install/templates/20120229194434_add_system_criteria_to_ac_filter.rb
+- lib/generators/prawn_report/install/templates/20120301063031_change_select_sql.rb
+- lib/generators/prawn_report/install/templates/20120303104431_change_filled_criteria_unfilled_criteria.rb
+- lib/generators/prawn_report/install/templates/20120316162712_add_filled_criteria_to_options.rb
+- lib/generators/prawn_report/install/templates/20120323124446_add_fields_to_filter.rb
+- lib/generators/prawn_report/install/templates/20130122101313_add_sql_query_to_ac_filter_def.rb
+- lib/generators/prawn_report/install/templates/20131107172133_add_excluir_to_report_template.rb
+- lib/prawn_report.rb
+- lib/prawn_report/engine.rb
+- lib/prawn_report/version.rb
+- lib/prawn_report_seeds.rb
+- lib/report.rb
+- lib/report_helpers.rb
+- lib/report_info.rb
+- repo/bands/footers/footer_001.rb
+- repo/bands/headers/header_001.rb
+- repo/bands/headers/header_002.rb
+- repo/reports/column_group.rb
+- repo/reports/listing.rb
+- repo/reports/simple_listing.rb
+homepage: http://www.acras.com.br/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Prawn Report makes it easy to create PDF reports.
+test_files: []