ruport 0.4.0 → 0.4.2

data/AUTHORS

@@ -1,14 +1,9 @@
 Developers:
 ---------------------------------------------------
-{Gregory Brown}[mailto:gregory.t.brown@gmail.com]:
 
-Original Author and Ruport::Report hacker.
+{Gregory Brown}[mailto:gregory.t.brown@gmail.com]
 
-{Robert Canieso}[mailto:rcanieso@gmail.com]:
-
-Currently lurking.  Soon to be tester / developer
-
-Contributors / People we've stole from:
+Contributors / People we've (legally) stole from:
 ---------------------------------------------------
 
 James Edward Gray II:

data/CHANGELOG

@@ -1,7 +1,24 @@
-The current version of Ruby Reports is 0.4.0
+The current version of Ruby Reports is 0.4.2
+
+changes since 0.4.0:
+
+- Brand new formatting system.
+  See: http://ruport.infogami.com/Formatting_System_HOWTO
+
+- DataSet#<< now returns self, e.g.
+  some_data << [1,2,3] << [4,5,6]
+
+- Removed fascist opt_require feature and Ruport::Base
+
+- Fixed bug in DataRow constructor which destroyed arrays.
+
+- Examples now included in gems
 
 changes since 0.3.8:
 
+
+- added DataRow#to_h
+
 - Ruport::Format.register_filter now passes the content it will modify via a
   block. e.g.
 
@@ -9,7 +26,7 @@ changes since 0.3.8:
 
 - Modified the license terms of Ruport so that it uses specifically the GPLv2.
   Further versions of Ruport may not be distributed under later versions of the
-  GPL without expressed permission.
+  GPL without explicit permission.
 
 - DataSet#[]= now passes rvals to DataRow constructor with fields from the
   DataSet it is called on.

data/LICENSE

@@ -7,7 +7,7 @@ or the {Ruby software license}[http://www.ruby-lang.org/en/LICENSE.txt].
 Please email Greg[mailto:gregory.t.brown_AT_gmail.com] with any questions.
 
 *Note:  This license refers specifically to GPLv2.
-Distributing under later versions of the GPL require explicit permission from
+Distributing under other versions of the GPL require explicit permission from
 Gregory Brown.  Though we will most likely adopt the GPLv3 when the final draft
 is published, we want to be able to make that decision for ourselves.
 

data/README

@@ -1,6 +1,11 @@
 # ------------------------------------------------------------------------
 # -------------------------------------------------------------------------
 #
+# WARNING: THIS DOCUMENT IS FREQUENTLY OUT OF DATE.
+# 
+# The most up to date information can be found at:
+# http://reporting.stonecode.org
+#
 # Contents:
 # 
 #   - What Ruport Is.
@@ -21,12 +26,12 @@
 #
 #  Optional Dependencies:
 #   
-#    Ruport has a number of optional dependencies:
+#    Ruport has a number of dependencies:
 #     
 #    Ruby/DBI and appropriate dbds: Makes Query useable 
 #    (must be installed manually)
 #
-#    FasterCSV: Silently enables fast CSV parsing
+#    FasterCSV: Enables fast CSV parsing
 #    (available via rubygems)
 #     
 #    RedCloth:  Enables textile/markdown filtering
@@ -35,25 +40,14 @@
 #    PDF::Writer: Enables printable documents via render_pdf (Experimental)
 #    (available via rubygems)
 #
-#    The recommended method of installing ruport is RubyGems.  It has been 
-#    split into two packages, one that installs all of the dependencies
-#    by default, and one which does not install them.  
-#
-#    None of the dependencies are mandatory, so you can still use Ruport
-#    without them, as long as you don't need their functionality.
+#  Note that by installing any of the dependencies, either via gems or manually,
+#  their functionality will automatically be enabled.
 #
 #  To install ruport via rubygems with all it's dependencies (except DBI):
 #   
 #    sudo gem install ruport
 #
-#  To install ruport via rubygems with no dependencies:
-#
-#    sudo gem install ruport-lean
-#
-#  Note that by installing any of the dependencies, either via gems or manually,
-#  their functionality will automatically be enabled in ruport-lean.
-#
-#  To install ruport manually:
+#  To install ruport manually via setup.rb:
 # 
 #    sudo ruby setup.rb
 #
@@ -103,8 +97,6 @@
 #  documentation, as well as encouraging design discussions and also am quite
 #  curious about what people use or want to use ruport for.
 #
-#  Ruby Reports (Ruport) is a report generation and formatting toolset.
-#
 #  I will announce Ruport releases on RubyTalk, on the Ruport mailing list, on
 #  Freshmeat, RAA, and the new_haven.rb mailing list.  If you would like to
 #  keep an eye out for releases, please monitor one of those places.
@@ -115,16 +107,8 @@
 #  - The latest stable API documentation is available at:
 #    http://ruport.rubyforge.org/docs
 #
-#  - If you'd like to get some news on Ruport, you can check out my blog.
-#    (http://stonecode.org/blog)
-#
 #  There also will be some tutorials on stonecode.org
 #
-#  From time to time I will release example packages on RubyForge.  Keep an eye
-#  out for these on ruport's project page and please note that unless otherwise
-#  noted, these examples are meant ONLY for the versions which they correspond
-#  to. (i.e. ruport-example-0.2.9 will NOT work with Ruport 0.3.8)
-#
 #  If you are interested in developing Ruport, please *never* study code in
 #  official releases.  As this software is in it's early stages, it's essential
 #  to keep an eye on the subversion repository.  If you let me know you are
@@ -133,7 +117,7 @@
 #
 #  - Grabbing the code from the svn trunk is simple:
 #
-#    svn checkout svn://rubyforge.org//var/svn/ruport
+#    svn co svn://rubyforge.org//var/svn/ruport/trunk/
 #
 #  Those who would like to become regular contributors will be given write
 #  access.  Also, anyone interested in the internal design and project
@@ -164,8 +148,7 @@
 #  methods to help you write a Reporting application
 #
 #  Format provides support for building filters and specialized formatting
-#  systems.  Format::Builder can be used to add additional formats which can be
-#  used by DataSet#as, and the Format class can add filters to Report#render
+#  systems. 
 # 
 #  Query currently provides a high level interface to DBI.  Soon it will support
 #  a mixin wrapper called Fetchable which will enable you to wrap whatever data

data/Rakefile

@@ -2,8 +2,13 @@ require "rake/rdoctask"
 require "rake/testtask"
 require "rake/gempackagetask"
 
-require "rubygems"
+begin
+  require "rubygems"
+rescue LoadError
+  nil
+end
 
+#Set to true to disable dependency resolution
 LEAN=false
 
 task :default => [:test]
@@ -16,14 +21,13 @@ end
 
 spec = Gem::Specification.new do |spec|
 	spec.name = LEAN ? "ruport-lean" : "ruport"
-	spec.version = "0.4.0"
+	spec.version = "0.4.2"
 	spec.platform = Gem::Platform::RUBY
 	spec.summary = "A generalized Ruby report generation and templating engine."
-
-	spec.files =  spec.files = FileList[
-   'lib/**/*.rb', 'bin/*', '[A-Z]*','test/**/*'].to_a.delete_if { |item|
-   item.include?("CVS") } + ["Rakefile"]
-	spec.require_path = "lib"
+	spec.files =  Dir.glob("{examples,lib,test}/**/*.rb") +
+                      ["Rakefile", "setup.rb"]
+  
+  spec.require_path = "lib"
 	
   spec.test_file = "test/ts_all.rb"
   

data/TODO

@@ -2,9 +2,27 @@ TODO: (Wiped clean for a fresh start as of 2006.02.20)
 
 Immediate Goals:
 
+  Bugs:
+
+    - The engine doesn't have a good way to give you cloned copies of the
+      Plugins meaningfully
+   
   Features:
 
-    - Make DataSet an XSet
+    - event system
+ 
+    - Add in a way to load partial datasets
+
+    - allow DataSet creation without field names.
+    
+    - Builder should have a no-fields option
+    
+    - Composite key selection
+
+    - Value modification predicate.
+      DataRow#set_value_if("my_value") { # my_condition }
+    
+    - Column based default values
 
     - Integrate Ruport::Parser into Report#parse and Format#parser
 

data/examples/fieldless_table.rb

@@ -0,0 +1,10 @@
+require "ruport"
+include Ruport
+
+
+class Format::Plugin::FieldlessCSVPlugin < Format::Plugin::CSVPlugin
+  rendering_options :show_field_names => false
+  plugin_name :fieldless_csv
+  register_on :table_engine
+end
+

data/examples/line_plotter.rb

@@ -0,0 +1,44 @@
+require "ruport"
+
+include Ruport
+
+class LinePlotter < Format::Engine
+  
+  Line = Struct.new(:x1,:y1,:x2,:y2)
+  
+  renderer do
+    active_plugin.data = get_lines
+    active_plugin.render_plot
+  end
+
+  def self.get_lines
+    data.map { |r| Line.new(r[0][0],r[0][1],r[1][0],r[1][1]) }
+  end
+  
+  alias_engine LinePlotter, :line_plotting_engine
+  Format.build_interface_for LinePlotter, :plot
+end
+
+class SVG < Format::Plugin
+
+  renderer :plot do
+    h = '<svg width="100%" height="100%" xmlns="http://www.w3.org/2000/svg">'+
+        '<g stroke="black" stroke-width="1">'
+    
+    data.inject(h) { |s,r|
+      s << "<line x1=\"#{r.x1}\" y1=\"#{r.y1}\"" <<
+           " x2=\"#{r.x2}\" y2=\"#{r.y2}\" />"
+    } << "</g></svg>"
+  end
+ 
+  register_on :line_plotting_engine
+end
+
+lines = [ [    [0,0],   [0,100] ], 
+          [  [0,100], [100,100] ], 
+          [ [100,100],  [100,0] ],
+          [   [100,0],    [0,0] ] ]
+
+a = Format.plot :plugin => :svg,
+                :data => lines 
+puts a

data/examples/new_plugin.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+require "ruport"
+
+include Ruport
+
+class Format::Plugin::Text < Ruport::Format::Plugin
+  renderer :table do
+    data.inject(rendered_field_names) { |s,r| 
+      s << r.to_a.join("()") << "\n" 
+    }
+  end
+
+  format_field_names do
+    data.fields.join("---") << "\n"
+  end
+
+  register_on :table_engine
+end
+
+puts Format.table({ :data => [[1,2],[3,4]].to_ds(%w[a b]),
+                    :plugin => :text })

data/examples/pdf.rb

@@ -0,0 +1,36 @@
+require "rubygems"
+require "ruport"
+
+# needs a DSL, but heres a sort of Raw support here.
+# will improve when linked into the new plugin system
+
+element = Ruport::Format::Element.new :e, 
+            :content => "Hello Ruport PDF rendering!",
+            :top => 2, :left => 4, :right => 4
+
+element2 = Ruport::Format::Element.new :e2, 
+            :content => File.read("examples/long.txt"),
+            :top => 20, :left => 2, :right => 2
+
+section = Ruport::Format::Section.new :s
+section << element
+
+section2 = Ruport::Format::Section.new :s2
+section2 << element2
+
+page    = Ruport::Format::Section.new :p
+page << section
+
+page2   = Ruport::Format::Page.new :p2
+page2 << section2 
+
+document = Ruport::Format::Document.new :d
+
+document << page
+document << page2
+
+
+pdf_builder = Ruport::Format::Builder.new(document)
+pdf_builder.format = :pdf_document
+
+puts pdf_builder.render

data/lib/ruport.rb

@@ -1,4 +1,3 @@
-begin; require "rubygems"; rescue LoadError; nil; end
 # ruport.rb : Ruby Reports toplevel module
 #
 # Author: Gregory T. Brown (gregory.t.brown at gmail dot com)
@@ -12,7 +11,10 @@ begin; require "rubygems"; rescue LoadError; nil; end
 #
 
 module Ruport
-  VERSION = "Ruby Reports Version 0.4.0"
+  
+  begin; require 'rubygems'; rescue LoadError; nil end
+  
+  VERSION = "Ruby Reports Version 0.4.2"
   
   # Ruports logging and error interface.
   # Can generate warnings or raise fatal errors
@@ -54,6 +56,6 @@ module Ruport
 end
 
 
-%w[base config report format query data_row data_set].each { |lib|
+%w[config report format query data_row data_set].each { |lib|
   require "ruport/#{lib}" 
 }

data/lib/ruport/data_row.rb

@@ -55,6 +55,7 @@ module Ruport
         
         #checks to ensure data is convertable
         verify data
+        data = data.dup
         
         @fields   = fields.dup
         @tags     = (options[:tags] || {}).dup

data/lib/ruport/data_set.rb

@@ -84,7 +84,7 @@ module Ruport
     def clone
       DataSet.new(@fields,@data)
     end
-    
+
     #Allows ordinal access to rows
     #
     #   my_data[2] -> Ruport::DataRow
@@ -105,7 +105,7 @@ module Ruport
     #    data << [ 1, 2, 3 ]
     #    data << { :some_field_name => 3, :other => 2, :another => 1 }
     def << ( stuff, filler=@default )
-      @data << DataRow.new(stuff,@fields,:filler => filler)
+      @data << DataRow.new(stuff,@fields,:filler => filler); self;  
     end
 
     # checks if one dataset equals another

data/lib/ruport/format.rb

@@ -8,7 +8,6 @@
 # your choice of the GNU General Public License or the Ruby License. 
 #
 # See LICENSE and COPYING for details
-%w[builder open_node document].each { |lib| require "ruport/format/#{lib}" }
 begin; require "faster_csv"; rescue LoadError; require "csv"; end
 module Ruport
   
@@ -60,13 +59,42 @@ module Ruport
 #
 # This part of Ruport is under active development.  Please do feel free to
 # submit feature requests or suggestions.
-  class Format < Ruport::Base
+  class Format
+      
+      def Format.build_interface_for(engine,name)
+        (class << self; self; end).send(:define_method, name, 
+          lambda { |options| simple_interface(engine, options) })
+        (class << self; self; end).send(:define_method, "#{name}_object",
+          lambda { |options|
+            options[:auto_render] = false; simple_interface(engine,options) })
+      end
+
+      %w[builder open_node document engine plugin].each { |lib|
+         require "ruport/format/#{lib}" 
+      }
+
+    class << self      
+
+      def simple_interface(engine, options={})
+        my_engine = engine.dup
+        
+        my_engine.send(:plugin=,options[:plugin])
+        options = my_engine.active_plugin.rendering_options.merge(options)
+       
+        options[:auto_render] = true unless options.has_key? :auto_render
+        
+        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
+      end
+
+    end
    
     @@filters = Hash.new
     
-    opt_require "redcloth", :filter_red_cloth
-  
-  # To hook up a Format object to your current class, you need to pass it a
+    # To hook up a Format object to your current class, you need to pass it a
     # binding.  This way, when filters are being processed, they will be
     # evaluated in the context of the object they are being called from, rather
     # than within an instance of Format.
@@ -90,6 +118,7 @@ module Ruport
     # Processes the RedCloth text in <tt>@content</tt> in the context
     # of the object that Format is bound to.
     def filter_red_cloth
+      require "redcloth"
       RedCloth.new(@content).to_html
     end