ruport 0.4.19 → 0.4.21

data/CHANGELOG

@@ -1,6 +1,23 @@
-The current version of Ruby Reports is 0.4.19
+The current version of Ruby Reports is 0.4.21
 
-changes since 0.4.1
+changes since 0.4.19
+- Added a rake task to run rcov
+
+- Removed DataSet / DataRow.  Farewell good friends
+
+- Added Array#to_table, dropped Array#to_ds
+
+- You can now convert Sets to Tables and vice-versa
+
+- acts_as_reportable converted to use Data::Table
+
+- Data::Record's constructor can now take a hash
+
+- Added initial Data::Set implementation
+
+- Added smart Data::Table.to_format method_missing functionality
+
+changes since 0.4.17
 
 - Made method_missing a lot more friendly all around.
 

data/Rakefile

@@ -12,8 +12,7 @@ end
 LEAN=false
 dir = File.dirname(__FILE__)
 lib = File.join(dir, "lib", "ruport.rb")
-version = File.read(lib)[/^\s*VERSION\s*=\s*(['"])(\d+\.\d+\.d+)\1/,2]
-
+version = File.read(lib)[/^\s*VERSION\s*=\s*(['"])(\d+\.\d+\.d+)['"]/,1]
 task :default => [:test]
 
 Rake::TestTask.new do |test|
@@ -24,7 +23,7 @@ end
 
 spec = Gem::Specification.new do |spec|
 	spec.name = LEAN ? "lean-ruport" : "ruport"
-	spec.version = "0.4.19"
+	spec.version = "0.4.21"
 	spec.platform = Gem::Platform::RUBY
 	spec.summary = "A generalized Ruby report generation and templating engine."
 	spec.files =  Dir.glob("{examples,lib,test}/**/**/*") +
@@ -66,10 +65,16 @@ Rake::RDocTask.new do |rdoc|
   rdoc.title    = "Ruport Documentation"
 end
 
-
 Rake::GemPackageTask.new(spec) do |pkg|
 	pkg.need_zip = true
 	pkg.need_tar = true
 end
 
-
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.test_files = [ "test/ts_all.rb" ]
+  end
+rescue LoadError
+  nil
+end

data/examples/new_plugin.rb

@@ -11,11 +11,11 @@ class Format::Plugin::Text < Ruport::Format::Plugin
   end
 
   format_field_names do
-    data.fields.join("---") << "\n"
+    data.column_names.join("---") << "\n"
   end
 
   register_on :table_engine
 end
 
-puts Format.table({ :data => [[1,2],[3,4]].to_ds(%w[a b]),
+puts Format.table({ :data => [[1,2],[3,4]].to_table(:column_names =>%w[a b]),
                     :plugin => :text })

data/lib/ruport.rb

@@ -14,7 +14,7 @@ module Ruport
   
   #begin; require 'rubygems'; rescue LoadError; nil end
   
-  VERSION = "0.4.19"
+  VERSION = "0.4.21"
   
   # Ruports logging and error interface.
   # Can generate warnings or raise fatal errors
@@ -67,6 +67,6 @@ module Ruport
 end
 
 
-%w[config meta_tools report format query data_row data_set data].each { |lib|
+%w[config meta_tools report format query data].each { |lib|
   require "ruport/#{lib}" 
 }

data/lib/ruport/data.rb

@@ -1 +1 @@
-%w[taggable record collection table].each { |l| require "ruport/data/#{l}" }
+%w[taggable record collection table set].each { |l| require "ruport/data/#{l}" }

data/lib/ruport/data/collection.rb

@@ -12,7 +12,15 @@ module Ruport::Data
     def as(type)
       Ruport::Format.table :data => self, :plugin => type
     end
+
+    def to_set
+      Set.new :data => data
+    end
     
+    def to_table(options={})
+      Table.new({:data => data.map { |r| r.to_a }}.merge(options))
+    end
+
     attr_reader :data
     def_delegators :@data, :each, :length, :[], :empty?
   end

data/lib/ruport/data/record.rb

@@ -6,8 +6,17 @@ module Ruport::Data
     include Taggable
 
     def initialize(data,options={})
-      @data = data.dup
-      @attributes = options[:attributes]
+      if data.kind_of?(Hash)
+        if options[:attributes]
+          @attributes = options[:attributes]
+          @data = options[:attributes].map { |k| data[k] }
+        else
+          @attributes, @data = data.to_a.transpose
+        end
+      else
+        @data = data.dup
+        @attributes = options[:attributes]
+      end
     end
 
     attr_reader :data
@@ -67,6 +76,10 @@ module Ruport::Data
     #FIXME: This does not take into account frozen / tainted state
     alias_method :clone, :dup
 
+    def hash
+      (attributes.to_a + data.to_a).hash
+    end
+
     def method_missing(id,*args)
       id = id.to_s.gsub(/=$/,"")
       if @attributes.include?(id)

data/lib/ruport/data/set.rb

@@ -0,0 +1,42 @@
+require 'set'
+
+module Ruport::Data
+  class Set < Collection
+    
+    def initialize(options={})
+      @data = ::Set.new
+      options[:data].each {|e| self << e} if options[:data]
+    end
+    
+    def <<(other)
+      case other
+        when Record 
+          @data << other
+        when Array
+          @data << Record.new(other)
+      end
+    end
+    
+    def ==(other)
+      @data == other.data
+    end
+    
+    def |(other)
+      Set.new :data => (@data | other.data)
+    end
+    alias_method :union, :|
+    
+    def &(other)
+      Set.new :data => (@data & other.data)
+    end
+    alias_method :intersection, :&
+    
+    # Set difference
+    def -(other)
+      Set.new :data => (@data - other.data)
+    end
+    alias_method :difference, :-
+    
+    def_delegators :@data, :each
+  end
+end

data/lib/ruport/data/table.rb

@@ -1,3 +1,9 @@
+class Array
+  def to_table(options={})
+    Ruport::Data::Table.new({:data => self}.merge(options))
+  end
+end
+
 module Ruport::Data
   class Table < Collection
     def initialize(options={})
@@ -12,6 +18,15 @@ module Ruport::Data
       @column_names = other.dup
     end
 
+    def eql?(other)
+      data.eql?(other.data) && column_names.eql?(other.column_names) 
+    end
+    alias_method :==, :eql?
+
+    def to_s
+      as(:text)
+    end
+
     def <<(other)
       case other
       when Array
@@ -86,6 +101,11 @@ module Ruport::Data
         Ruport::Data::Record.new data, :attributes => group
       end
     end
+    
+    def method_missing(id,*args)
+     return as($1.to_sym) if id.to_s =~ /^to_(.*)/ 
+     super
+    end
 
   end
 end

data/lib/ruport/format.rb

@@ -19,17 +19,11 @@ module Ruport
 # There are three main sets of functionality the Ruport::Format model provides.
 #   * Structured printable document support ( Format::Document and friends)
 #   * Text filter support ( Report#render and the Format class)
-#   * Support for DataSet Formatting ( Format::Builder)
 #
 # The support for structured printable documents is currently geared towards PDF
 # support and needs some additional work to be truly useful.  Suggestions would
 # be much appreciated.
 #
-# Format::Builder lets you define functions that will be used via DataSet#as
-# This is primary geared towards tabular data output, but there is no reason why
-# DataSet#as and the <tt>render_foo</tt> methods of Format::Builder cannot be
-# adapted to fit whatever needs you may need.
-#
 # The filters implemented in the Format class are meant to process strings or
 # entire templates.  The Format class will soon automatically build a
 # Ruport::Parser for any string input.  By default, filters are provided to

data/lib/ruport/format/engine.rb

@@ -94,6 +94,23 @@ module Ruport
     private_class_method :new
   end
   
+ class Format::Engine::Invoice < Ruport::Format::Engine
+
+    # order meta data
+    attributes [:customer_info, :company_info]
+   
+    renderer do
+      super
+      build_company_header
+      build_customer_header
+      active_plugin.render_invoice
+    end
+  
+    alias_engine Invoice, :invoice_engine
+    Ruport::Format.build_interface_for Invoice, :invoice
+  
+  end
+
   class Format::Engine::Table < Format::Engine      
         
      renderer do
@@ -109,7 +126,7 @@ module Ruport
       def rewrite_column(key,&block)
         data.each { |r| r[key] = block[r] }
       end
- 
+
       def num_cols
         data[0].to_a.length
       end

data/lib/ruport/format/plugin.rb

@@ -106,7 +106,7 @@ module Ruport
 
       action :max_col_width do |index|
         f = data.column_names if data.respond_to? :column_names
-        d = DataSet.new f, :data => data
+        d = Data::Table.new :column_names => f, :data => data
         
         cw = d.map { |r| r[index].to_s.length }.max
         
@@ -119,9 +119,11 @@ module Ruport
 
       action :table_width do
         f = data.column_names if data.respond_to? :column_names
-        d = DataSet.new f, :data => data 
+        d = Data::Table.new:column_names => f, :data => data 
 
-        d[0].attributes.inject(0) { |s,e| s + max_col_width(e) }
+        f = d[0].attributes || (0...d[0].length)
+
+        f.inject(0) { |s,e| s + max_col_width(e) }
       end
 
       action :hr do
@@ -136,10 +138,16 @@ module Ruport
     end
 
     class PDFPlugin < Format::Plugin
-     
+      attribute :pdf
+      attribute :paper
+
+      helper(:init_plugin) {
+        require "pdf/writer"
+        require "pdf/simpletable"
+        self.pdf = PDF::Writer.new( :paper => paper || "LETTER" )
+      }
+
       renderer :table do
-        require "pdf/writer"; require "pdf/simpletable";
-        pdf = PDF::Writer.new
         pre[pdf] if pre
         PDF::SimpleTable.new do |table|
           table.maximum_width = 500
@@ -156,8 +164,78 @@ module Ruport
 
       format_field_names { data.column_names }
       
+      renderer :invoice do
+        return unless defined? PDF::Writer
+     
+        pdf.start_page_numbering(500, 20, 8, :right)
+       
+        # order contents 
+        pdf.y = 620
+        
+        PDF::SimpleTable.new do |table|
+          table.width = 450
+          table.orientation = :center
+          table.data = data
+          table.show_lines = :outer
+          table.column_order = data.column_names
+          table.render_on(pdf)
+          table.font_size = 12
+        end
+         
+          
+        # footer
+        pdf.open_object do |footer|
+          pdf.save_state
+          pdf.stroke_color! Color::Black
+          pdf.stroke_style! PDF::Writer::StrokeStyle::DEFAULT
+        
+          pdf.add_text_wrap( 50, 20, 200, "Printed at " + 
+                             Time.now.strftime("%H:%M %d/%m/%Y"), 8)
+
+          pdf.restore_state
+          pdf.close_object
+          pdf.add_object(footer, :all_pages)
+        end
+        
+        pdf.stop_page_numbering(true, :current)
+        pdf.render
+      end
+
+      # Company Information in top lefthand corner
+      helper(:build_company_header) { |eng| 
+        text_box(eng.company_info)
+      }
+
+      
+
+      helper(:build_order_helper) { }
+
+      # Order details
+      helper(:build_customer_header) { |eng| 
+        pdf.y -= 10
+        text_box(eng.customer_info)
+      }
+     
+      def self.text_box(content,options={})
+        PDF::SimpleTable.new do |table| 
+          table.data = content.to_a.inject([]) do |s,line|
+            s << { "value" => line }
+          end
+          table.column_order = "value"
+          table.show_headings = false
+          table.show_lines  = :outer
+          table.shade_rows  = :none
+          table.width       = options[:width]    || 200
+          table.orientation = options[:orientation] || :right
+          table.position = options[:position] || :left
+          table.font_size = options[:font_size] || 10
+          table.render_on(pdf)
+        end
+      end
+       
       plugin_name :pdf
       register_on :table_engine
+      register_on :invoice_engine     
     end
 
     class HTMLPlugin < Format::Plugin

data/lib/ruport/query.rb

@@ -4,7 +4,7 @@ require "ruport/query/sql_split"
 module Ruport
   
   # Query offers a way to interact with databases via DBI.  It supports
-  # returning result sets in either Ruport's native DataSets, or in their raw
+  # returning result sets in either Ruport's native Data::Table, or in their raw
   # form as DBI::Rows.
   #
   # It offers basic caching support, the ability to instantiate a generator for
@@ -25,7 +25,7 @@ module Ruport
     # This kind of laziness is supposed to be A Good Thing, and
     # as long as you keep it in mind, it should not cause any problems.
     #
-    # The SQL can be single or multistatement, but the resulting DataSet will
+    # The SQL can be single or multistatement, but the resulting Data::Table will
     # consist only of the result of the last statement which returns something.
     #
     # Options:
@@ -106,7 +106,7 @@ module Ruport
       fetch &action
     end
     
-    # Grabs the result set as a DataSet or if in raw_data mode, an array of
+    # Grabs the result set as a Data::Table or if in raw_data mode, an array of
     # DBI:Row objects
     def result; fetch; end
     
@@ -137,7 +137,7 @@ module Ruport
       @cache_enabled = false
     end
     
-    # Returns a DataSet, even if in raw_data mode
+    # Returns a Data::Table, even if in raw_data mode
     # Does not work with raw data if cache is enabled and filled
     def to_dataset
       data_flag, @raw_data = @raw_data, false
@@ -160,7 +160,7 @@ module Ruport
       
       require "dbi"
       
-      data = @raw_data ? [] : DataSet.new
+      data = @raw_data ? [] : Data::Table.new
       DBI.connect(@dsn, @user, @password) do |dbh|
         dbh.execute(query_text) do |sth|
             return unless sth.fetchable?