ruport 0.4.9 → 0.4.11

data/AUTHORS

@@ -2,22 +2,20 @@ Developers:
 ---------------------------------------------------
 
 {Gregory Brown}[mailto:gregory.t.brown@gmail.com]
+{Dudley Flanders}[mailto:dudley@misnomer.us]
 
-Contributors / People we've (legally) stole from:
+Contributors / People we've (legally) stolen from:
 ---------------------------------------------------
 
 James Edward Gray II:
-Original inspiration via query.rb
-Parse::Input which is the base for Ruport::Parser
+- Original inspiration via query.rb
+- system_extensions.rb
 
 Francis Hwang:
-SQLSplit
+- SQLSplit
 
 Simon Claret:
-PDF table support for Format::Builder
-
-Dudley Flanders:
-DataSet improvements
+- PDF table support 
 
 Dinko Mehinovic:
-util/release/raa.rb
+- util/release/raa.rb

data/CHANGELOG

@@ -1,4 +1,39 @@
-The current version of Ruby Reports is 0.4.9
+The current version of Ruby Reports is 0.4.11
+
+changes since 0.4.9
+
+- DataSet#column_names and DataRow#column_names have been added as alias to
+  fields.
+
+- Plugins are now safely copied when used via DataSet#as or the generated
+  Format::simple_interface(Format.table,Format.document,etc)
+
+- Dropped insert_row / insert_column from Format::Engine::Table.
+  These are no longer needed.
+
+- Reworked format engine unit tests to decouple from specific plugins.
+
+- vendored SystemExtensions from HighLine to get terminal_width /
+  terminal_height functions
+
+- DataSet#add_columns and DataSet#add_columns! has been added
+
+- Added pre and post hooks for Plugins.  Individual plugins choose if and 
+  how to implement them.
+
+- Parser is gone
+
+- Format::Builder is gone
+
+- fixed a bug in rails support. :columns now works properly.
+
+- fieldnames can now be disabled in CSV loading
+
+- DataSet.load now loads empty cells as nil instead "" by default
+
+- fixed HTML table output in HTMLPlugin
+
+- Select / Remove columns now accepts ordinal indexes 
 
 changes since 0.4.5:
 
@@ -72,7 +107,6 @@ changes since 0.4.0:
 
 changes since 0.3.8:
 
-
 - added DataRow#to_h
 
 - Ruport::Format.register_filter now passes the content it will modify via a

data/Rakefile

@@ -21,7 +21,7 @@ end
 
 spec = Gem::Specification.new do |spec|
 	spec.name = LEAN ? "lean-ruport" : "ruport"
-	spec.version = "0.4.9"
+	spec.version = "0.4.11"
 	spec.platform = Gem::Platform::RUBY
 	spec.summary = "A generalized Ruby report generation and templating engine."
 	spec.files =  Dir.glob("{examples,lib,test}/**/**/*") +
@@ -52,7 +52,20 @@ quickly and cleanly.
 END_DESC
 end
 
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_files.include( "README",
+                           "TODO", "CHANGELOG",
+                           "AUTHORS", "COPYING",
+                           "LICENSE", "lib/" )
+  rdoc.main     = "README"
+  rdoc.rdoc_dir = "doc/html"
+  rdoc.title    = "Ruport Documentation"
+end
+
+
 Rake::GemPackageTask.new(spec) do |pkg|
 	pkg.need_zip = true
 	pkg.need_tar = true
 end
+
+

data/TODO

@@ -2,13 +2,6 @@ TODO: (Wiped clean for a fresh start as of 2006.02.20)
 
 Immediate Goals:
 
-  Bugs:
-
-    - DataSet deep cloning is broken thanks to activerecord.
-
-    - The format engine doesn't have a good way to give you cloned copies 
-      of the Plugins meaningfully
-   
   Features:
 
     - event system

data/examples/create.sql

@@ -0,0 +1,2 @@
+
+  

data/examples/sql_query.rb

@@ -0,0 +1,19 @@
+require "rubygems"
+require "ruport"
+Ruport.configure { |c| 
+  c.source :default, :dsn => "dbi:mysql:ruport", :user => "root"
+}
+
+SQL = <<-EOS
+  drop table if exists people;
+  create table people(
+    id int not null auto_increment,
+    name text,
+    email varchar(50),
+    primary key (id)
+  );
+  insert into people VALUES(NULL, 'gregory', 'g@g.com')
+EOS
+
+Ruport::Query.new(SQL).execute
+p Ruport::Query.new("select * from people").result 

data/lib/ruport.rb

@@ -14,7 +14,7 @@ module Ruport
   
   begin; require 'rubygems'; rescue LoadError; nil end
   
-  VERSION = "Ruby Reports Version 0.4.9"
+  VERSION = "Ruby Reports Version 0.4.11"
   
   # Ruports logging and error interface.
   # Can generate warnings or raise fatal errors

data/lib/ruport/data_row.rb

@@ -73,7 +73,8 @@ module Ruport
 
       
       attr_accessor :fields, :tags
-
+      alias_method  :column_names, :fields
+      
       # Returns a new DataRow
       def +(other)
         DataRow.new @fields + other.fields, :data => (@data + other.to_a)

data/lib/ruport/data_set.rb

@@ -47,6 +47,7 @@ module Ruport
     
     #an array which contains column names
     attr_accessor :fields
+    alias_method  :column_names, :fields
     
     #the default value to fill empty cells with 
     attr_accessor :default
@@ -167,7 +168,8 @@ module Ruport
     #   my_data = Ruport::DataSet.load("foo.csv")
     #   my_data = Ruport::DataSet.load("foo.yaml")
     #   my_data = Ruport::DataSet.load("foo.yml")
-    def self.load ( source, default="", &block)
+    def self.load ( source, options={}, &block)
+      options = {:has_names => true}.merge(options)
       case source
       when /\.(yaml|yml)/
         return YAML.load(File.open(source))
@@ -181,10 +183,12 @@ module Ruport
         else 
           lambda { |r| loaded_data << r } 
         end
+       
+        loaded_data.fields = input[0] if options[:has_names]
+        input = input[1..-1] if options[:has_names] 
         
-        loaded_data.fields = input[0]
-        loaded_data.default = default
-        input[1..-1].each { |row| action[row] }
+        loaded_data.default = options[:default]
+        input.each { |row| action[row] }
         return loaded_data	
       else
         raise "Invalid file type"
@@ -194,6 +198,7 @@ module Ruport
 
     # Returns a new DataSet composed of the fields specified.
     def select_columns(*fields)
+      fields = get_field_names(fields)
       rows = fields.inject([]) { |s,e| s << map { |row| row[e] } }.transpose
       my_data = DataSet.new(fields, :data => rows)
     end
@@ -204,16 +209,26 @@ module Ruport
        @fields = a.fields; @data   = a.data
     end
       
+    #Creates a new dataset with additional columns appending to it
+    def add_columns(*fields)
+      select_columns *(@fields + fields)
+    end
+
+    def add_columns!(*fields)
+      select_columns! *(@fields + fields)
+    end
     
     # Returns a new DataSet with the specified fields removed
     def remove_columns(*fields)
+      fields = get_field_names(fields)
       select_columns(*(@fields-fields))
     end
 
     # removes the specified fields from this DataSet (DESTRUCTIVE!)
     def remove_columns!(*fields)
-      @fields -= fields
-      @data = select_columns(*(@fields)).to_a
+      d = remove_columns(*fields)
+      @data   = d.data
+      @fields = d.fields
     end
 
     # uses Format::Builder to render DataSets in various ready to output
@@ -262,6 +277,13 @@ module Ruport
     # Readable string representation of the DataSet
     def to_s; as(:text) end
 
+    private
+
+    def get_field_names(f)
+      f.all? { |e| e.kind_of? Integer } &&
+      f.inject([]) { |s,e| s << @fields[e] } || f
+    end
+    
   end
 end
 

data/lib/ruport/format.rb

@@ -68,7 +68,7 @@ module Ruport
             options[:auto_render] = false; simple_interface(engine,options) })
       end
 
-      %w[builder open_node document engine plugin].each { |lib|
+      %w[open_node document engine plugin].each { |lib|
          require "ruport/format/#{lib}" 
       }
 
@@ -83,13 +83,13 @@ module Ruport
         options[:auto_render] = true unless options.has_key? :auto_render
         
 
-        options[:data] &&= options[:data].dup
+        options[:data] = options[:data].dup
         
         options.each do |k,v|
           my_engine.send("#{k}=",v) if my_engine.respond_to? k
         end
         
-        options[:auto_render] ? my_engine.render : my_engine
+        options[:auto_render] ? my_engine.render : my_engine.dup
       end
 
     end

data/lib/ruport/format/engine.rb

@@ -2,7 +2,6 @@ module Ruport
   class Format::Engine
     require "forwardable"
     
-    
     class << self
 
       include Enumerable
@@ -16,32 +15,36 @@ module Ruport
       end
 
       attr_accessor :engine_klasses
+      attr_reader :plugin 
+      attr_reader :data
+      attr_accessor :klass_binding
       
       def alias_engine(klass,name)
         Format::Engine.engine_klasses ||= {}
         Format::Engine.engine_klasses[name] = klass
       end
 
-      def format_plugins
-        @format_plugins ||= {}
+      def data=(data)
+        @data = data
+        active_plugin.data = data.dup if active_plugin
       end
       
-      def accept_format_plugin(klass) 
-        format_plugins[klass.format_name] = klass
+      def active_plugin
+        @format_plugins[:current]  
+        #plugin && @format_plugins[plugin]
       end
 
-      def plugin_names
-        format_plugins.keys
+      def plugin=(p)
+        @plugin = p
+        @format_plugins[:current] = @format_plugins[p].dup
+        @format_plugins[:current].data = self.data.dup if self.data 
       end
-
-      def plugins
-        format_plugins.values
-      end
-
-      def active_plugin
-          plugin && @format_plugins[plugin]
+      
+      def apply_erb
+       active_plugin.data = 
+         ERB.new(active_plugin.data).result(klass_binding || binding)
       end
-
+ 
       def render
         raise "No plugin specified" unless plugin
         raise "No data provided" unless data
@@ -52,53 +55,47 @@ module Ruport
         self.data = nil
       end
       
-      def apply_erb
-       active_plugin.data = 
-         ERB.new(active_plugin.data).result(klass_binding || binding)
+      def accept_format_plugin(klass) 
+        format_plugins[klass.format_name] = klass
       end
 
-      attr_accessor :plugin 
-      attr_accessor :data
-      attr_accessor :klass_binding
-      
+      private  
+
+      def format_plugins
+        @format_plugins ||= {}
+      end
+
+      def plugin_names
+        format_plugins.keys
+      end
+
+      def plugins
+        format_plugins.values
+      end 
+
     end
   end
   
   class Format::Engine::Table < Format::Engine      
         
      renderer do
-        super 
+        super
         active_plugin.rendered_field_names = "" 
-        build_field_names if (data.respond_to?(:fields) && show_field_names)
-        active_plugin.render_table
+        build_field_names if (data.respond_to?(:fields) && 
+                              data.fields && show_field_names)
+        a = active_plugin.render_table
       end
 
     class << self
-      def insert_column(options)
-        filler = options[:filler].to_s 
-        nr_action = if (index = options[:left_of])
-          lambda { |e| e.to_a[0..index-1] + [filler] + e.to_a[index..-1] }
-        elsif (index = options[:right_of])
-          lambda { |e| e.to_a[0..index] + [filler] + e.to_a[index+1..-1] }
-        end
-        self.data = self.data.inject([]) { |a,r|
-          a << nr_action[r]
-        }
-      end
-
-      def insert_row(options)
-        filler = options[:filler].to_s
-        self.data = if (index = options[:above])
-           data.to_a[0..index-1] + [filler] + data.to_a[index..-1] 
-         elsif (index = options[:below])
-           data.to_a[0..index] + [filler] + data.to_a[index+1..-1] 
-         end
-      end 
 
       def rewrite_column(key,&block)
         data.each { |r| r[key] = block[r] }
       end
  
+      def num_cols
+        data[0].to_a.length
+      end
+
       attr_accessor :show_field_names
       
       private
@@ -134,7 +131,6 @@ module Ruport
         require "redcloth"
         active_plugin.data = RedCloth.new(active_plugin.data).to_html
       end
-
           
     end
     

data/lib/ruport/format/plugin.rb

@@ -41,6 +41,7 @@ module Ruport
       end
       
       attr_accessor :rendered_field_names
+      attr_accessor :pre, :post
    end
     
     
@@ -48,7 +49,7 @@ module Ruport
        
       format_field_names do
         require "fastercsv"
-        FasterCSV.generate { |csv| csv << data.fields } 
+        FasterCSV.generate { |csv| csv << data.fields }
       end
       
       renderer :table do
@@ -61,30 +62,75 @@ module Ruport
     end
 
     class TextPlugin < Format::Plugin
-      
       rendering_options :erb_enabled => true, :red_cloth_enabled => false
 
       renderer :document
       
-      renderer :table do
-        indices = (0...data.length).to_a
-        data.inject(rendered_field_names){ |s,r| 
-          s << "row#{indices.shift}: ( #{r.to_a.join(', ')} )\n"
+      renderer :table do 
+        require "ruport/system_extensions" 
+        
+        th = "#{rendered_field_names}#{hr}"
+       
+        data.each { |r|
+          r.each_with_index { |f,i|
+            r[i] = f.to_s.center(max_col_width(i))
+          }
         }
+        
+        a = data.inject(th){ |s,r| 
+          s << "| #{r.to_a.join(' | ')} |\n"
+        } << hr
+
+        width = self.right_margin || SystemExtensions.terminal_width
+        
+        a.split("\n").each { |r|
+           r.gsub!(/\A.{#{width},}/) { |m| m[0,width-2] += ">>" }
+        }.join("\n") << "\n"
       end
       format_field_names do
-        "fields: ( #{data.fields.join(', ')} )\n"
+        data.fields.each_with_index { |f,i| 
+          data.fields[i] = f.to_s.center(max_col_width(i))
+        }
+        "#{hr}| #{data.fields.to_a.join(' | ')} |\n"
+      end
+
+      def self.max_col_width(index) 
+        f = data.fields if data.respond_to? :fields
+        d = DataSet.new f, :data => data
+        
+        cw = d.map { |r| r[index].to_s.length }.max
+        
+        return cw unless d.fields
+        
+        nw = (index.kind_of?(Integer) ? d.fields[index] : index ).to_s.length
+        
+        [cw,nw].max
+      end
+
+      def self.table_width
+        f = data.fields if data.respond_to? :fields
+        d = DataSet.new f, :data => data 
+
+        d[0].fields.inject(0) { |s,e| s+=max_col_width(e) }
       end
 
+      def self.hr
+        len = data[0].to_a.length * 3 + table_width + 1
+        "+" + "-"*(len-2) + "+\n"
+      end
+
+      class << self; attr_accessor :right_margin; end
+
       register_on :table_engine
       register_on :document_engine
     end
 
     class PDFPlugin < Format::Plugin
+     
       renderer :table do
         require "pdf/writer"; require "pdf/simpletable";
-        return unless defined? PDF::Writer
         pdf = PDF::Writer.new
+        pre[pdf] if pre
         PDF::SimpleTable.new do |table|
           table.maximum_width = 500
           table.orientation = :center
@@ -94,6 +140,7 @@ module Ruport
           table.column_order = self.rendered_field_names
           table.render_on(pdf)
         end
+        post[pdf] if post
         pdf.render
       end
 
@@ -110,7 +157,8 @@ module Ruport
       
       renderer :table do
         rc = data.inject(rendered_field_names) { |s,r| 
-          s << "|#{r.to_a.join('|')}|\n" 
+          row = r.map { |e| e.to_s.empty? ? "&nbsp;" : e }
+          s << "|#{row.to_a.join('|')}|\n" 
         }
         Format.document :data => rc, :plugin => :html 
       end