RubyGems - ruport - Versions diffs - 1.2.3 → 1.4.0 - Mend

ruport 1.2.3 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (36) hide show

data/Rakefile +2 -4
data/examples/centered_pdf_text_box.rb +2 -6
data/examples/pdf_report_with_common_base.rb +2 -5
data/examples/png_embed.rb +3 -8
data/examples/simple_templating_example.rb +7 -7
data/examples/tattle_rubygems_version.rb +0 -3
data/lib/ruport/data/grouping.rb +11 -10
data/lib/ruport/data/record.rb +3 -1
data/lib/ruport/data/table.rb +0 -14
data/lib/ruport/formatter/csv.rb +10 -15
data/lib/ruport/formatter/html.rb +4 -6
data/lib/ruport/formatter/pdf.rb +50 -91
data/lib/ruport/formatter/template.rb +33 -15
data/lib/ruport/formatter/text.rb +22 -26
data/lib/ruport/formatter.rb +27 -11
data/lib/ruport/renderer/grouping.rb +0 -6
data/lib/ruport/renderer/table.rb +0 -4
data/lib/ruport/renderer.rb +64 -78
data/lib/ruport.rb +7 -4
data/test/csv_formatter_test.rb +8 -8
data/test/grouping_test.rb +10 -10
data/test/helpers.rb +2 -0
data/test/html_formatter_test.rb +5 -5
data/test/pdf_formatter_test.rb +23 -14
data/test/record_test.rb +5 -0
data/test/renderer_test.rb +103 -47
data/test/table_test.rb +111 -138
data/test/template_test.rb +12 -1
data/test/text_formatter_test.rb +12 -14
metadata +69 -88
data/lib/ruport/acts_as_reportable.rb +0 -378
data/lib/ruport/query/sql_split.rb +0 -33
data/lib/ruport/query.rb +0 -232
data/test/acts_as_reportable_test.rb +0 -272
data/test/query_test.rb +0 -259
data/test/sql_split_test.rb +0 -20

data/Rakefile CHANGED Viewed

@@ -1,9 +1,8 @@
 require "rake/rdoctask"
 require "rake/testtask"
 require "rake/gempackagetask"
-#
-RUPORT_VERSION = "1.2.3"
+RUPORT_VERSION = "1.4.0"
 begin
   require "rubygems"
@@ -33,9 +32,8 @@ spec = Gem::Specification.new do |spec|
   spec.extra_rdoc_files = %w{README LICENSE AUTHORS}
   spec.rdoc_options << '--title' << 'Ruport Documentation' <<
                        '--main'  << 'README' << '-q'
-  spec.add_dependency('transaction-simple', "=1.4.0")
   spec.add_dependency('fastercsv', '>= 1.1.0')
-  spec.add_dependency('pdf-writer', '>= 1.1.3')
+  spec.add_dependency('pdf-writer', '= 1.1.7')
   spec.author = "Gregory Brown"
   spec.email = "  gregory.t.brown@gmail.com"
   spec.rubyforge_project = "ruport"

data/examples/centered_pdf_text_box.rb CHANGED Viewed

@@ -8,13 +8,9 @@ require "ruport"
 #
 class Document < Ruport::Renderer
-  # will throw an error if these options are not set at rendering time
+  # Will throw an error if these options are not set at rendering time
   required_option :text, :author
-  # allows this option to be set directly on a renderer instance,
-  # and creates a reader for it if a header() method does not already exist
-  option :heading
   # The renderer will look for a build_document_body() method on the formatter,
   # but silently skip this stage if it is missing
   stage :document_body
@@ -84,4 +80,4 @@ took flesh. To be great is to be misunderstood. . . .
 EOS
 end
-puts a
+puts a

data/examples/pdf_report_with_common_base.rb CHANGED Viewed

@@ -19,12 +19,9 @@ class ClientRenderer < Ruport::Renderer
   prepare :standard_report
   stage :company_header, :client_header, :client_body, :client_footer
   finalize :standard_report
-  option :example
   def setup
     data.rename_columns { |c| c.to_s.titleize }
-    # this lets us omit the options prefix in the formatter
-    formatter.class.opt_reader(:example)
   end
 end
@@ -58,7 +55,7 @@ class ClientPDF < CompanyPDFBase
   def build_client_header
    pad(10) do
-    add_text "Specific Report Header with example=#{example}",
+    add_text "Specific Report Header with example=#{options.example}",
              :justification => :center, :font_size => 12
    end
   end
@@ -72,4 +69,4 @@ table = Table([:a,:b,:c]) << [1,2,3] << [4,5,6]
 File.open("example.pdf","w") do |f|
   f << ClientRenderer.render_pdf(:data => table,:example => "apple")
-end
+end

data/examples/png_embed.rb CHANGED Viewed

@@ -2,9 +2,6 @@ require "rubygems"
 require "ruport"
 class RoadmapRenderer < Ruport::Renderer
-  option :image_file
   stage :roadmap_image, :roadmap_text_body
   finalize :roadmap
 end
@@ -12,7 +9,6 @@ end
 class HTMLRoadmap < Ruport::Formatter
   renders :html, :for => RoadmapRenderer
-  opt_reader :image_file
   def layout
      output << "<html><body>\n"
@@ -21,7 +17,7 @@ class HTMLRoadmap < Ruport::Formatter
   end
   def build_roadmap_image
-    output << "<img src='#{image_file}'/>"
+    output << "<img src='#{options.image_file}'/>"
   end
   def build_roadmap_text_body
@@ -33,10 +29,9 @@ end
 class PDFRoadmap < Ruport::Formatter::PDF
   renders :pdf, :for => RoadmapRenderer
-  opt_reader :image_file
   def build_roadmap_image
-    center_image_in_box image_file, :x => 0, :y => 200,
+    center_image_in_box options.image_file, :x => 0, :y => 200,
                                    :width => 624, :height => 432
     move_cursor_to 80
   end
@@ -56,4 +51,4 @@ formats = [:html, :pdf]
 formats.each do  |format|
   RoadmapRenderer.render(format, :image_file => "roadmap.png",
                                  :file => "roadmap.#{format}")
-end
+end

data/examples/simple_templating_example.rb CHANGED Viewed

@@ -1,24 +1,24 @@
 require "ruport"
-Ruport::Formatter::Template.create(:simple) do |t|
-  t.page_format = {
+Ruport::Formatter::Template.create(:simple) do |format|
+  format.page = {
     :size   => "LETTER",
     :layout => :landscape
   }
-  t.text_format = {
+  format.text = {
     :font_size => 16
   }
-  t.table_format = {
+  format.table = {
     :font_size      => 16,
     :show_headings  => false
   }
-  t.column_format = {
+  format.column = {
     :alignment => :center,
   }
-  t.heading_format = {
+  format.heading = {
     :alignment => :right
   }
-  t.grouping_format = {
+  format.grouping = {
     :style => :separated
   }
 end

data/examples/tattle_rubygems_version.rb CHANGED Viewed

@@ -1,10 +1,8 @@
 # A dump of the database for this example can be found in ./data/tattle.dump
 require "active_record"
 require "ruport"
 # Update with your connection parameters
 ActiveRecord::Base.establish_connection(
     :adapter  => 'mysql',
@@ -37,4 +35,3 @@ sorted_table = rubygems_versions.sort_rows_by("count", :order => :descending)
 sorted_table.reduce { |r| r["platform"] !~ /darwin/i }
 g = Grouping(sorted_table, :by => "platform", :order => "name")
 puts g.to_pdf

data/lib/ruport/data/grouping.rb CHANGED Viewed

@@ -79,6 +79,12 @@ module Ruport::Data
     alias_method :==, :eql?
+    protected
+    attr_writer :name, :subgroups #:nodoc:
+    private
     # Creates subgroups for the group based on the supplied column name.  Each
     # subgroup is a hash whose keys are the unique values in the column.
     #
@@ -93,23 +99,18 @@ module Ruport::Data
       if @subgroups.empty?
         @subgroups = grouped_data(group_column)
       else
-        @subgroups.each {|name,group| group.create_subgroups(group_column) }
+        @subgroups.each {|name,group|
+          group.send(:create_subgroups, group_column)
+        }
       end
     end
-    protected
-    attr_writer :name, :subgroups #:nodoc:
-    private
     def grouped_data(group_column) #:nodoc:
       data = {}
       group_names = column(group_column).uniq
       columns = column_names.dup
       columns.delete(group_column)
       group_names.each do |name|
-        # FIXME - this doesn't seem to reduce the data set
         group_data = sub_table(columns) {|r|
           r.send(group_column) == name
         }
@@ -172,7 +173,7 @@ module Ruport::Data
         @data = data.to_group.send(:grouped_data, cols.shift)
         cols.each do |col|
           @data.each do |name,group|
-            group.create_subgroups(col)
+            group.send(:create_subgroups, col)
           end
         end
       end
@@ -378,7 +379,7 @@ module Kernel
   #
   # Example:
   #
-  #   a = [[1,2,3],[4,5,6]].to_table(%w[a b c])
+  #   a = Table(%w[a b c], :data => [[1,2,3],[4,5,6]])
   #   b = Grouping(a, :by => "a")   #=> creates a new grouping on column "a"
   #
   def Grouping(*args)

data/lib/ruport/data/record.rb CHANGED Viewed

@@ -16,7 +16,9 @@ module Ruport::Data
   # as Array-like, Hash-like, or Struct-like objects.  They are used as the
   # base element for Data::Table
   #
-  class Record
+  class Record
+    private :id
     include Enumerable

data/lib/ruport/data/table.rb CHANGED Viewed

@@ -824,17 +824,3 @@ module Kernel
     return table
   end
 end
-class Array
-  # Converts an array to a Ruport::Data::Table object, ready to
-  # use in your reports.
-  #
-  # Example:
-  #   [[1,2],[3,4]].to_table(%w[a b])
-  #
-  def to_table(column_names=nil,&b)
-    Ruport::Data::Table.new({:data => self, :column_names => column_names},&b)
-  end
-end

data/lib/ruport/formatter/csv.rb CHANGED Viewed

@@ -32,16 +32,11 @@ module Ruport
     renders :csv, :for => [ Renderer::Row,   Renderer::Table,
                             Renderer::Group, Renderer::Grouping ]
-    opt_reader :show_table_headers,
-               :format_options,
-               :show_group_headers,
-               :style
     # Hook for setting available options using a template. See the template
     # documentation for the available options and their format.
     def apply_template
-      apply_table_format_template(template.table_format)
-      apply_grouping_format_template(template.grouping_format)
+      apply_table_format_template(template.table)
+      apply_grouping_format_template(template.grouping)
       options.format_options ||= template.format_options
     end
@@ -52,22 +47,22 @@ module Ruport
     # This method does not do anything if options.show_table_headers is false
     # or the Data::Table has no column names.
     def build_table_header
-      unless data.column_names.empty? || !show_table_headers
-        render_row data.column_names, :format_options => format_options
+      unless data.column_names.empty? || !options.show_table_headers
+        render_row data.column_names, :format_options => options.format_options
       end
     end
     # Calls the row renderer for each row in the Data::Table
     def build_table_body
       render_data_by_row { |r|
-        r.options.format_options = format_options
+        r.options.format_options = options.format_options
       }
     end
     # Produces CSV output for a data row.
     def build_row
       require "fastercsv"
-      output << FCSV.generate_line(data,format_options || {})
+      output << FCSV.generate_line(data,options.format_options || {})
     end
     # Renders the header for a group using the group name.
@@ -86,14 +81,14 @@ module Ruport
     # column names.
     #
     def build_grouping_header
-      unless style == :inline
+      unless options.style == :inline
         output << "#{data.grouped_by}," << grouping_columns
       end
     end
     # Determines the proper style to use and renders the Grouping.
     def build_grouping_body
-      case style
+      case options.style
       when :inline
         render_inline_grouping(options)
       when :justified, :raw
@@ -112,9 +107,9 @@ module Ruport
     def render_justified_or_raw_grouping
       data.each do |_,group|
-        output << "#{group.name}" if style == :justified
+        output << "#{group.name}" if options.style == :justified
         group.each do |row|
-          output << "#{group.name if style == :raw}," << row.to_csv
+          output << "#{group.name if options.style == :raw}," << row.to_csv
         end
         output << "\n"
       end

data/lib/ruport/formatter/html.rb CHANGED Viewed

@@ -28,13 +28,11 @@ module Ruport
     renders :html, :for => [ Renderer::Row, Renderer::Table,
                              Renderer::Group, Renderer::Grouping ]
-    opt_reader :show_table_headers, :show_group_headers, :style
     # Hook for setting available options using a template. See the template
     # documentation for the available options and their format.
     def apply_template
-      apply_table_format_template(template.table_format)
-      apply_grouping_format_template(template.grouping_format)
+      apply_table_format_template(template.table)
+      apply_grouping_format_template(template.grouping)
     end
     # Generates table headers based on the column names of your Data::Table.
@@ -43,7 +41,7 @@ module Ruport
     # or the Data::Table has no column names.
     def build_table_header
       output << "\t<table>\n"
-      unless data.column_names.empty? || !show_table_headers
+      unless data.column_names.empty? || !options.show_table_headers
         output << "\t\t<tr>\n\t\t\t<th>" +
           data.column_names.join("</th>\n\t\t\t<th>") +
           "</th>\n\t\t</tr>\n"
@@ -89,7 +87,7 @@ module Ruport
     # renders them using the group renderer.
     #
     def build_grouping_body
-      case style
+      case options.style
       when :inline
         render_inline_grouping(options)
       when :justified

data/lib/ruport/formatter/pdf.rb CHANGED Viewed

@@ -39,41 +39,13 @@ module Ruport
   #     Grouping:
   #       * style (:inline,:justified,:separated,:offset)
   #
-  class Formatter::PDF < Formatter
-    module PDFWriterMemoryPatch #:nodoc:
-      unless self.class.instance_methods.include?("_post_transaction_rewind")
-        def _post_transaction_rewind
-          @objects.each { |e| e.instance_variable_set(:@parent,self) }
-        end
-      end
-    end
-    module PDFSimpleTableOrderingPatch #:nodoc:
-      def __find_table_max_width__(pdf)
-         #p "this actually gets called"
-         max_width = PDF::Writer::OHash.new(-1)
+  class Formatter::PDF < Formatter
-         # Find the maximum cell widths based on the data and the headings.
-         # Passing through the data multiple times is unavoidable as we must
-         # do some analysis first.
-         @data.each do |row|
-           @cols.each do |name, column|
-             w = pdf.text_width(row[name].to_s, @font_size)
-             w *= PDF::SimpleTable::WIDTH_FACTOR
-             max_width[name] = w if w > max_width[name]
-           end
-         end
-         @cols.each do |name, column|
-           title = column.heading.title if column.heading
-           title ||= column.name
-           w = pdf.text_width(title, @heading_font_size)
-           w *= PDF::SimpleTable::WIDTH_FACTOR
-           max_width[name] = w if w > max_width[name]
-         end
-         max_width
+    module PDFWriterProxy #:nodoc:
+      def method_missing(id,*args)
+        super(id,*args)
+      rescue
+        pdf_writer.send(id,*args)
       end
     end
@@ -82,11 +54,15 @@ module Ruport
     attr_writer :pdf_writer
-    opt_reader  :style,
-                :table_format,
-                :text_format,
-                :paper_size,
-                :paper_orientation
+    # If you use this macro in your formatter, Ruport will automatically forward
+    # calls to the underlying PDF::Writer, for any methods that are not wrapped
+    # or redefined.
+    def self.proxy_to_pdf_writer
+      include PDFWriterProxy
+    end
+    save_as_binary_file
     def initialize
       Ruport.quiet do
@@ -98,12 +74,12 @@ module Ruport
     # Hook for setting available options using a template. See the template
     # documentation for the available options and their format.
     def apply_template
-      apply_page_format_template(template.page_format)
-      apply_text_format_template(template.text_format)
-      apply_table_format_template(template.table_format)
-      apply_column_format_template(template.column_format)
-      apply_heading_format_template(template.heading_format)
-      apply_grouping_format_template(template.grouping_format)
+      apply_page_format_template(template.page)
+      apply_text_format_template(template.text)
+      apply_table_format_template(template.table)
+      apply_column_format_template(template.column)
+      apply_heading_format_template(template.heading)
+      apply_grouping_format_template(template.grouping)
     end
     # Returns the current PDF::Writer object or creates a new one if it has not
@@ -111,9 +87,8 @@ module Ruport
     #
     def pdf_writer
       @pdf_writer ||= options.formatter ||
-        ::PDF::Writer.new( :paper => paper_size || "LETTER",
-              :orientation => paper_orientation || :portrait)
-      @pdf_writer.extend(PDFWriterMemoryPatch)
+        ::PDF::Writer.new( :paper => options.paper_size || "LETTER",
+              :orientation => options.paper_orientation || :portrait)
     end
     # Calls the draw_table method.
@@ -142,7 +117,7 @@ module Ruport
     # Determines which style to use and renders the main body for
     # Renderer::Grouping.
     def build_grouping_body
-      case style
+      case options.style
       when :inline
         render_inline_grouping(options.to_hash.merge(:formatter => pdf_writer,
             :skip_finalize_table => true))
@@ -170,7 +145,7 @@ module Ruport
     #   add_text("Hello Joe") #renders at 14pt
     #   add_text("Hello Mike",:font_size => 16) # renders at 16pt
     def add_text(text, format_opts={})
-      format_opts = text_format.merge(format_opts) if text_format
+      format_opts = options.text_format.merge(format_opts) if options.text_format
       pdf_writer.text(text, format_opts)
     end
@@ -245,25 +220,6 @@ module Ruport
       move_cursor_to(opts.y - opts.height)
     end
-    # Adds an image to every page. The color and size won't be modified,
-    # but it will be centered.
-    #
-    def watermark(imgpath)
-      x = pdf_writer.absolute_left_margin
-      y = pdf_writer.absolute_bottom_margin
-      width = pdf_writer.absolute_right_margin - x
-      height = pdf_writer.absolute_top_margin - y
-      pdf_writer.open_object do |wm|
-        pdf_writer.save_state
-        center_image_in_box(imgpath, :x => x, :y => y,
-          :width => width, :height => height)
-        pdf_writer.restore_state
-        pdf_writer.close_object
-        pdf_writer.add_object(wm, :all_pages)
-      end
-    end
     # Adds n to pdf_writer.y, moving the vertical drawing position in the
     # document.
     def move_cursor(n)
@@ -274,6 +230,15 @@ module Ruport
     def move_cursor_to(n)
       pdf_writer.y = n
     end
+    # Moves the vertical drawing position in the document upwards by n.
+    def move_up(n)
+      pdf_writer.y += n
+    end
+    def move_down(n)
+      pdf_writer.y -= n
+    end
     # Adds a specified amount of whitespace above and below the code
     # in your block.  For example, if you want to surround the top and
@@ -317,15 +282,15 @@ module Ruport
       raise FormatterError, m if table_data.column_names.empty?
       table_data.rename_columns { |c| c.to_s }
-      if table_format
-        format_opts = Marshal.load(Marshal.dump(table_format.merge(format_opts)))
-      end
+      if options.table_format
+        format_opts =
+          Marshal.load(Marshal.dump(options.table_format.merge(format_opts)))
+      end
       old = pdf_writer.font_size
-      ::PDF::SimpleTable.new do |table|
-        table.extend(PDFSimpleTableOrderingPatch)
+      ::PDF::SimpleTable.new do |table|
         table.maximum_width = 500
         table.column_order  = table_data.column_names
         table.data = table_data
@@ -338,12 +303,7 @@ module Ruport
       pdf_writer.font_size = old
     end
-    # Save the output to a file.
-    def save_output(filename)
-      File.open(filename,"wb") {|f| f << output }
-    end
     # This module provides tools to simplify some common drawing operations.
     # It is included by default in the PDF formatter.
     #
@@ -482,14 +442,14 @@ module Ruport
     def render_justified_or_separated_grouping
       table = table_with_grouped_by_column
       data.each do |name,group|
-        group_column = { data.grouped_by => "<b>#{name}</b>\n" }
-        group.each_with_index do |rec,i|
-          # FIXME - Find the source of the bug requiring to_a
-          i == 0 ?
-            table << group_column.merge(rec.to_hash) :
-            table << rec.to_a.unshift(nil)
+        group.each_with_index do |r,i|
+          if i == 0
+            table << { data.grouped_by => "<b>#{name}</b>" }.merge(r.to_hash)
+          else
+            table << r
+          end
         end
-        table << Array.new(grouping_columns.length,' ') if style == :separated
+        table << [" "] if options.style == :separated
       end
       render_table table, options.to_hash.merge(:formatter => pdf_writer)
     end
@@ -497,9 +457,8 @@ module Ruport
     def render_offset_grouping
       table = table_with_grouped_by_column
       data.each do |name,group|
-        table << ["<b>#{name}</b>\n",nil,nil]
-        # FIXME - Find the source of the bug requiring to_a
-        group.each {|r| table << r.to_a.unshift(nil) }
+        table << ["<b>#{name}</b>"]
+        group.each {|r| table << r }
       end
       render_table table, options.to_hash.merge(:formatter => pdf_writer)
     end