ruport 0.8.14 → 0.10.0

data/lib/ruport/data/taggable.rb

@@ -1,80 +0,0 @@
-# The Ruport Data Collections.
-# Authors: Gregory Brown / Dudley Flanders
-#
-# This is Free Software.  For details, see LICENSE and COPYING
-# Copyright 2006 by respective content owners, all rights reserved.
-module Ruport::Data
-  
-  require 'set'  
-  #
-  # === Overview
-  # 
-  # This module provides a simple mechanism for tagging arbitrary objects.  
-  # It provides the necessary methods to set and retrieve tags which can 
-  # consist of any Ruby object.
-  #
-  module Taggable
-
-    #
-    # Adds a tag to the object.
-    #
-    # Example:
-    #
-    #   taggable_obj.tag :spiffy
-    #
-    def tag(tag_name)
-      tags << tag_name 
-    end
-    
-    #
-    # Removes a tag from the object.
-    #
-    # Example:
-    #
-    #   taggable_obj.delete_tag :not_so_spiffy
-    #
-    def delete_tag(tag_name)
-      tags.delete tag_name
-    end
-  
-    #
-    # Checks to see if a tag is present.
-    #
-    # Example:
-    #
-    #   taggable_obj.has_tag? :spiffy #=> true
-    #
-    def has_tag?(tag_name)
-      tags.include? tag_name
-    end
-  
-    # 
-    # Returns an Set of the object's tags.
-    #
-    # Example:
-    #
-    #   taggable_obj.tags #=> #<Set: {:spiffy, :kind_of_spiffy}>
-    #
-    def tags              
-      @ruport_tags ||= Set.new
-    end
-   
-    # 
-    # Sets the tags.
-    #
-    # Example:
-    #
-    #   taggable_obj.tags = [:really_dang_spiffy, :the_most_spiffy]
-    #
-    def tags=(tags_list)     
-      case tags_list
-      when Array
-        @ruport_tags = Set.new(tags_list)
-      else
-        @ruport_tags = tags_list
-      end
-    end
-
-  end
-  
-end

data/lib/ruport/format.rb

@@ -1 +0,0 @@
-require "ruport/format/plugin"

data/lib/ruport/format/csv.rb

@@ -1,29 +0,0 @@
-module Ruport::Format
-
-  # This plugin implements the CSV format for tabular data output. 
-  # See also:  Renderer::Table
-  class CSV < Plugin
-    
-    # Generates table header by turning column_names into a CSV row.
-    # Uses build_csv_row to generate the actual formatted output
-    #
-    # This method does not do anything if layout.show_table_headers is false or
-    # the Data::Table has no column names.
-    def build_table_header
-      unless data.column_names.empty? || !layout.show_table_headers
-        build_csv_row(data.column_names)
-      end
-    end
-
-    # Calls build_csv_row for each row in the Data::Table
-    def build_table_body
-      data.each { |r| build_csv_row(r) }
-    end
-
-    # Produces CSV output for a data row.
-    def build_csv_row(row)
-      require "fastercsv"
-      output << FasterCSV.generate { |csv| csv << row } 
-    end
-  end
-end

data/lib/ruport/format/html.rb

@@ -1,42 +0,0 @@
-module Ruport::Format
-  # Produces HTML output for tabular data.
-  #
-  # See also Renderer::Table
-  class HTML < Plugin
-    
-    # Generates table headers based on the column names of your Data::Table.  
-    #
-    # This method does not do anything if layout.show_table_headers is false or
-    # the Data::Table has no column names.
-    def build_table_header
-      output << "\t<table>\n"
-      unless data.column_names.empty? || !layout.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"
-      end
-    end
-    
-    # Generates the <tr> and <td> tags for each row, calling to_s on each
-    # element of the Record.  If the Record has been tagged, the tags will be
-    # converted into class attributes in the HTML output.
-    #
-    def build_table_body
-      output << data.inject("") do |s,r| 
-        row = r.map { |e| e.to_s.empty? ? "&nbsp;" : e }
-        #classstr = r.tags.inject("") {|cs,c| cs + " class='#{c}'" }   
-        classstr = 
-          r.tags.length > 0 ? " class='#{r.tags.to_a.join(' ')}'" : ""
-        s + "\t\t<tr#{classstr}>\n\t\t\t<td#{classstr}>" +
-          row.to_a.join("</td>\n\t\t\t<td#{classstr}>") + 
-          "</td>\n\t\t</tr>\n"
-      end 
-    end
-
-    # Simply closes the table tag. 
-    def build_table_footer
-      output << "\t</table>"
-    end
-
-  end
-end

data/lib/ruport/format/latex.rb

@@ -1,47 +0,0 @@
-module Ruport::Format
-  class Latex < Plugin #:nodoc:
-
-    attr_accessor :caption
-   
-    def build_table_header
-      output << "\\documentclass[11pt]{article}\n"     <<
-                "\\RequirePackage{lscape,longtable}\n" <<
-                "\\begin{document}\n" <<
-                "\\begin{longtable}[c]{ "
-        
-        data.column_names.each do
-          output << " p{2cm} "
-        end
-        output << " }\n"
-        output << "\\hline\n"
-
-        output << "\\textsc{#{data.column_names[0]}}"
-        data.column_names[1..-1].each do |t|
-          output << " & "
-          output << "\\textsc{#{t}}"
-        end
-
-        output << "\\\\\n"
-        output << "\\hline\n"
-        output << "\\endhead\n"
-        output << "\\endfoot\n"
-        output << "\\hline\n"
-    end
-
-    def build_table_body
-      data.each do |r|
-        output << r.to_a.join(" & ") + "\\\\\n"
-        output << "\\hline\n"
-      end
-      if caption
-        output << "\\caption[#{caption}]{#{caption}}\n"
-      end
-      output << "\\end{longtable}\n"
-    end
-
-    def build_table_footer
-      output << "\\end{document}\n"
-    end
-
-  end
-end

data/lib/ruport/format/pdf.rb

@@ -1,233 +0,0 @@
-module Ruport::Format
-
-  # PDF generation plugin
-  #
-  #  layout options:
-  #     General:
-  #       * paper_size  #=> "LETTER"
-  #       * orientation #=> :center
-  #     
-  #     Table:
-  #       * table_width
-  #       * max_table_width #=> 500
-  #
-  class PDF < Plugin
-    attr_writer :pdf_writer
-    attr_accessor :table_header_proc
-    attr_accessor :table_footer_proc
-
-    # Does the necessary PDF::Writer requires
-    def initialize
-      require "pdf/writer"
-      require "pdf/simpletable"
-    end
-
-    # Returns the current PDF::Writer object or creates a new one if it has not
-    # been set yet.
-    #
-    def pdf_writer
-      @pdf_writer ||= 
-        ::PDF::Writer.new( :paper => layout.paper_size || "LETTER" )
-    end
-
-    # If table_header_proc is defined, it will be executed and the PDF::Writer
-    # object will be yielded.
-    #
-    # This should be overridden by subclasses, or used as a shortcut for your
-    # own plugin implementations
-    #
-    # This method is automatically called by the table renderer
-    #
-    def build_table_header
-       table_header_proc[pdf_writer] if table_header_proc
-    end
-
-    # Calls the draw_table method
-    #
-    # This method is automatically called by the table renderer
-    #
-    def build_table_body
-      draw_table
-    end
-
-    # If table_footer_proc is defined, it will be executed and the PDF::Writer
-    # object will be yielded.
-    #
-    # This should be overridden by subclasses, or used as a shortcut for your
-    # own plugin implementations
-    #
-    # This method is automatically called by the table renderer
-    #
-    def build_table_footer
-      table_footer_proc[pdf_writer] if table_footer_proc
-    end
-
-    # Appends the results of PDF::Writer#render to output for your 
-    # <tt>pdf_writer</tt> object.
-    #
-    def finalize_table
-      output << pdf_writer.render
-    end
-
-    # Call PDF::Writer#text with the given arguments
-    def add_text(*args)
-      pdf_writer.text(*args)
-    end
-       
-    # - if the image is bigger than the box, it will be scaled down until it fits
-    # - if the image is smaller than the box it's won't be resized
-    #
-    # arguments:
-    # - x: left bound of box
-    # - y: bottom bound of box
-    # - width: width of box
-    # - height: height of box
-    def center_image_in_box(path, x, y, width, height)
-      info = ::PDF::Writer::Graphics::ImageInfo.new(File.read(path))
-
-      # if the image is larger than the requested box, prepare to
-      # scale it down
-      fits = !(info.width > width || info.height > height)
-
-      # setup initial sizes for the image. These will be reduced as necesary
-      img_width = info.width
-      img_height = info.height
-      img_ratio = info.height.to_f / info.width.to_f
-
-      # reduce the size of the image until it fits into the requested box
-      until fits
-        img_width -= 1
-        img_height = img_width * img_ratio
-        fits = true if img_width < width && img_height < height
-      end
-
-      # if the width of the image is less than the requested box, calculate
-      # the white space buffer
-      if img_width < width
-        white_space = width - img_width
-        x = x + (white_space / 2)
-      end
-
-      # if the height of the image is less than the requested box, calculate
-      # the white space buffer
-      if img_height < height
-        white_space = height - img_height
-        y = y + (white_space / 2)
-      end
-
-      pdf_writer.add_image_from_file(path, x, y, img_width, img_height) 
-    end
-
-    # Draws some text on the canvas, surrounded by a box with rounded corners
-    #
-    def rounded_text_box(text)
-       opts = OpenStruct.new
-       yield(opts)
-       
-       # resize the text automatically to ensure it isn't wider than the box
-       loop do
-         sz = pdf_writer.text_width( text, opts.font_size )
-         opts.x + sz > opts.x + opts.width or break
-         opts.font_size -= 1
-       end
-
-       # save the drawing state (colors, etc) so we can restore it later
-       pdf_writer.save_state
-
-       # draw our box
-       pdf_writer.fill_color(opts.fill_color || Color::RGB::White)
-       pdf_writer.stroke_color(opts.stroke_color || Color::RGB::Black)
-       pdf_writer.rounded_rectangle( opts.x, opts.y, 
-                                     opts.width, opts.height, 
-                                     opts.radius).fill_stroke
-
-       # if a heading for this box has been specified
-       if opts.heading
-         pdf_writer.line( opts.x, opts.y - 20, 
-                          opts.x + opts.width, opts.y - 20).stroke
-         pdf_writer.fill_color(Color::RGB::Black)
-         move_cursor_to(opts.y - 3)
-         add_text("<b>#{opts.heading}</b>", 
-           :absolute_left => opts.x, :absolute_right => opts.x + opts.width,
-           :justification => :center, :font_size => opts.font_size)
-       end
-
-       # restore the original colors
-       pdf_writer.restore_state
-
-       # move our y cursor into position, write the text, then move the cursor
-       # to be just below the box
-       pdf_writer.y = opts.heading ? opts.y - 20 : opts.y
-
-       add_text( text,  :absolute_left  => opts.x,
-                        :absolute_right => opts.x + opts.width,
-                        :justification => opts.justification || :center,
-                        :font_size => opts.font_size )     
-
-       pdf_writer.y = 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, y, width, height)
-        pdf_writer.restore_state
-        pdf_writer.close_object
-        pdf_writer.add_object(wm, :all_pages)
-      end
-    end
-    
-    # moves the PDF::Writer cursor by dy points
-    # NOTE: In PDF::Writer, 0 is at the bottom of the page.
-    def move_cursor(dy) 
-      pdf_writer.y += dy
-    end
-
-    # moves the PDF::Writer cursor to the y position specified
-    def move_cursor_to(y)
-      pdf_writer.y = y
-    end
-
-    # moves the cursor down by dy, executes the block, and moves the cursor
-    # again.
-    #
-    # Example:
-    #
-    #   # Add a padding of 5 to a text element
-    #
-    #   pad(5) { add_text "hello" }
-    #   
-    def pad(dy,&block)
-      move_cursor -dy
-      block.call
-      move_cursor -dy
-    end
-
-    # Used by Renderer::Table to draw a SimpleTable.
-    # table_width, max_table_width and orientation can all be set via the
-    # <tt>layout</tt> object
-    #
-    def draw_table
-      m = "Sorry, cant build PDFs from array like things (yet)"
-      raise m if data.column_names.empty?
-      ::PDF::SimpleTable.new do |table|
-        table.maximum_width = layout.max_table_width || 500
-        table.width         = layout.table_width if layout.table_width
-        table.orientation   = layout.orientation || :center
-        table.data          = data
-        table.column_order  = data.column_names
-        table.render_on(pdf_writer)
-      end
-    end
-
-
-  end
-end

data/lib/ruport/format/plugin.rb

@@ -1,31 +0,0 @@
-# format/plugin.rb : Generalized formatting plugin base class for Ruby Reports
-#
-# Created by Gregory Brown.  Copyright December 2006, All Rights Reserved.
-#
-# This is free software, please see LICENSE and COPYING for details.
-
-module Ruport
-  module Format
-    class Plugin
-
-      attr_accessor :layout
-      attr_accessor :data
-
-      # Stores a string used for outputting formatted data.
-      def output
-        @output ||= ""
-      end
-
-      # Provides a generic OpenStruct for storing plugin options
-      def options
-        @options ||= OpenStruct.new
-      end 
-
-      # clears output.  Useful if you are building your own interface to
-      # plugins.
-      def clear_output
-        @output.replace("")
-      end
-    end
-  end
-end