ruport-util 0.1.0

data/Rakefile

@@ -0,0 +1,69 @@
+require "rake/rdoctask"
+require "rake/testtask"
+require "rake/gempackagetask"
+
+begin
+  require "rubygems"
+rescue LoadError
+  nil
+end
+
+task :default => [:test]
+
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.test_files = Dir[ "test/test_*.rb" ]
+  test.verbose = true
+end
+
+spec = Gem::Specification.new do |spec|
+  spec.name = "ruport-util"
+  spec.version = "0.1.0"
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "A set of tools and helper libs for Ruby Reports"
+  spec.files =  Dir.glob("{example,lib,test,bin}/**/**/*") +
+                      ["Rakefile"]
+  
+  spec.require_path = "lib"
+  
+  spec.test_files = Dir[ "test/test_*.rb" ]
+  spec.bindir = "bin"
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = %w{}
+  spec.rdoc_options << '--title' << 'Ruport Documentation' #<<
+                      # '--main'  << 'README' << '-q'
+  spec.add_dependency('ruport', ">=0.9.3")
+  spec.add_dependency('scruffy', ">=0.2.2")
+  spec.author = "Gregory Brown"
+  spec.email = "  gregory.t.brown@gmail.com"
+  spec.rubyforge_project = "ruport"
+  spec.homepage = "http://code.rubyreports.org"
+  spec.description = <<END_DESC
+  ruport-util provides a number of utilities and helper libs
+  for Ruby Reports
+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
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.test_files = Dir[ "test/test_*.rb" ]
+  end
+rescue LoadError
+  nil
+end

data/example/graph_report.rb

@@ -0,0 +1,17 @@
+require "rubygems"
+require "ruport"
+
+require "ruport/util/graph"
+
+class GraphReport < Ruport::Report
+  
+  def generate
+    graph = Ruport::Graph(:column_names => %w[a b c d e])
+    graph.add_line [1,2,3,4,5], :name => "foo" 
+    graph.add_line [11,22,70,2,19], :name => "bar"
+    graph.to_svg
+  end
+
+end
+
+GraphReport.run { |r| r.write("foo.svg") }

data/example/invoice_report.rb

@@ -0,0 +1,28 @@
+require "rubygems"
+require "ruport"
+require "ruport/util/invoice"
+
+class SampleReport < Ruport::Report
+  include Invoice
+
+  def generate
+    render_invoice do |i|
+      i.data = Table("Item Number","Description","Price") { |t|
+        t << %w[101 Erlang\ The\ Movie $1000.00]
+        t << %w[102 Erlang\ The\ Book $45.95] 
+      }
+      i.company_info  = "Stone Code Productions\n43 Neagle Street"
+      i.customer_info = "Gregory Brown\n200 Foo Ave.\n"
+      i.comments      = "Hello Mike!  Hello Joe!"
+      i.order_info    = "Some info\nabout your order"
+      i.title         = "Invoice for 12.15.2006 - 12.31.2006"
+      i.options do |o|
+        o.body_width = 480
+        o.comments_font_size = 12
+        o.title_font_size = 10  
+      end
+    end
+  end
+end
+
+SampleReport.run { |r| r.write "out.pdf" }

data/example/managed_report.rb

@@ -0,0 +1,37 @@
+require "rubygems"
+require "ruport"
+require "ruport/util/report_manager"
+
+class MyReport < Ruport::Report
+  
+  acts_as_managed_report 
+   
+  def generate
+     "Hello Mike"
+  end
+  
+end      
+
+class YourReport < Ruport::Report
+  
+  acts_as_managed_report
+  
+  def generate
+    "Hello Joe"
+  end 
+  
+end  
+
+class HisReport < Ruport::Report
+  
+  acts_as_managed_report
+  
+  def generate
+    "Hello Robert"
+  end 
+  
+end
+
+%w[MyReport YourReport HisReport].each do |report|
+  puts Ruport::ReportManager[report].run  
+end

data/lib/ruport/util/graph.rb

@@ -0,0 +1,186 @@
+# renderer/graph.rb
+# Generalized graphing support for Ruby Reports
+#
+# Written by Gregory Brown, Copright December 2006, All Rights Reserved.
+#
+# This is free software.  See LICENSE and COPYING for details.
+#
+
+begin
+  require "rubygems"
+  gem "ruport", ">= 0.9.3"
+rescue LoadError
+  nil
+end
+
+module Ruport
+
+  def Graph(*args)
+    Graph.new(*args)
+  end
+
+  module_function :Graph
+
+  class Graph < Ruport::Data::Table
+
+    class Line < Ruport::Data::Record
+      attr_accessor :name      
+      
+      def initialize_copy(from) 
+         @name = from.name.dup if from.name
+      end
+    end
+
+    def initialize(options={})
+      super({:record_class => Line}.merge(options))
+    end
+
+    def add_line(row_data,options={})
+      self << row_data
+      self[-1].name = options[:name]
+    end 
+    
+    def dup                   
+      obj = self.class.new(:column_names => column_names)  
+      data.each { |r| obj.add_line(r.to_a,:name => r.name)}   
+      return obj
+    end
+    
+    def as(format,*args,&block)
+      Ruport::Renderer::Graph.render(format,*args,&block)
+    end
+
+    def method_missing(id,*args,&block)
+      id.to_s =~ /^to_(.*)/
+      $1 ? as($1.to_sym,{:data => self}.merge(args[0]||{}),&block) : super
+    end
+
+  end
+  
+  # This class implements the basic graphing engine for Ruport.
+  #
+  # == Supported Format Plugins
+  # 
+  # * Format::XML
+  # * Format::SVG
+  #
+  # == Default layout options
+  #
+  # * height #=> 350
+  # * width  #=> 500
+  # * style  #=> :line
+  #
+  # ==  Plugin hooks called (in order)
+  # 
+  # * prepare_graph
+  # * build_graph
+  # * finalize_graph
+  class Renderer::Graph < Renderer
+
+    options { |o| o.style  = :line }
+
+    prepare :graph
+
+    stage :graph
+
+    finalize :graph
+
+  end
+  
+  class SVG < Formatter
+
+    renders :svg, :for => Renderer::Graph
+
+    # a hash of Scruffy themes.
+    #
+    # You can use these by setting options.theme like this:
+    #
+    #   Graph.render_svg { |r| r.options.theme = r.plugin.themes[:mephisto] }
+    #  
+    # Available themes: ( :mephisto, :keynote, :ruby_blog )
+    #
+    def themes
+      { :mephisto => Scruffy::Themes::Mephisto.new,
+        :keynote  => Scruffy::Themes::Keynote.new,
+        :ruby_blog => Scruffy::Themes::RubyBlog.new }
+    end
+
+    # generates a scruffy graph object
+    def initialize
+      quiet { require 'scruffy' }
+      
+      @graph = Scruffy::Graph.new
+    end
+
+    # the Scruffy::Graph object
+    attr_reader :graph
+
+    # sets the graph title, theme, and column_names
+    #
+    # column_names are defined by the Data::Table,
+    # theme may be specified by options.theme (see SVG#themes)
+    # title may be specified by options.title 
+    #
+    def prepare_graph 
+      @graph.title ||= options.title
+      @graph.theme = options.theme if options.theme
+      @graph.point_markers ||= data.column_names
+
+    end
+
+    # Generates an SVG using Scruffy.
+    def build_graph
+      data.each_with_index do |r,i|
+        add_line(r.to_a,r.name||"series #{i+1}")
+      end
+
+      output << @graph.render( 
+        :size => [options.width||500, options.height||300]
+      )
+    end
+    
+    # Uses Scruffy::Graph#add to add a new line to the graph.
+    #
+    # Line style is determined by options.style
+    #
+    def add_line(row,label)
+      @graph.add( options.style, label, row )
+    end
+
+  end
+  
+  class XML_SWF < Formatter
+
+    renders :xml_swf, :for => Renderer::Graph
+
+    def prepare_graph
+      gem "builder"              
+      require "builder"
+      @builder = Builder::XmlMarkup.new(:indent => 2)
+    end
+
+    def build_graph
+      output << @builder.chart do |b|
+        b.chart_type(options.style.to_s)
+
+        b.chart_data do |cd|
+          
+          cd.row { |first|
+            first.null
+            data.column_names.each { |c| first.string(c) }
+          }
+          
+          data.each_with_index { |r,i|       
+            label = r.name || "Region #{i}"
+            cd.row { |data_row|
+              data_row.string(label)
+              r.each { |e| data_row.number(e) }
+            }
+          }
+        end
+      end
+    end
+
+  end
+
+end

data/lib/ruport/util/invoice.rb

@@ -0,0 +1,138 @@
+module Ruport
+  class Renderer
+    class Invoice < Ruport::Renderer
+               
+      required_option :customer_info,:company_info,:order_info,:comments
+
+      option :title
+      
+      stage :invoice_headers,:invoice_body,:invoice_footer
+      
+      finalize :invoice
+
+      module InvoiceHelpers
+        def build_company_header
+          @tod = pdf_writer.y
+          rounded_text_box(options.company_info) { |o| 
+              o.radius    = 3  
+              o.width     = options.header_width || 200
+              o.height    = options.header_height || 50
+              o.font_size = options.header_font_size || 10
+              o.y         = pdf_writer.y
+              o.x         = pdf_writer.absolute_left_margin + 10
+          }
+        end
+
+        def build_customer_header
+          move_cursor -5
+          rounded_text_box(options.customer_info) { |o| 
+              o.radius    = 3
+              o.width     = options.header_width || 200
+              o.height    = options.header_height || 50
+              o.font_size = options.header_font_size || 10
+              o.y         = pdf_writer.y
+              o.x         = pdf_writer.absolute_left_margin + 10
+          }
+        end
+
+        def build_title
+          add_title(options.title) if options.title
+        end
+        
+        def add_title( title )  
+          rounded_text_box("<b>#{title}</b>") do |o|
+            o.fill_color = Color::RGB::Gray80
+            o.radius    = 5  
+            o.width     = options.header_width || 200
+            o.height    = options.header_height || 20
+            o.font_size = options.header_font_size || 11
+            o.x         = pdf_writer.absolute_right_margin - o.width 
+            o.y         = pdf_writer.absolute_top_margin
+          end
+        end      
+
+        def build_order_header
+          if options.order_info
+            rounded_text_box("<b>#{options.order_info}</b>") do |o|
+              o.radius    = 5  
+              o.heading   = "Billing Information"
+              o.width     = options.header_width || 200
+              o.height    = options.header_height || 80
+              o.font_size = options.header_font_size || 10
+              o.x         = pdf_writer.absolute_right_margin - o.width 
+              o.y         = pdf_writer.absolute_top_margin - 25
+            end 
+          end
+        end
+
+        def horizontal_line(x1,x2)
+          pdf_writer.line(x1,pdf_writer.y,x2,pdf_writer.y)
+          pdf_writer.stroke
+        end
+                                  
+      end
+       
+      class PDF < Ruport::Formatter::PDF
+        
+        include InvoiceHelpers
+        renders :pdf, :for => Renderer::Invoice
+
+        def build_invoice_headers
+          build_company_header
+          build_customer_header
+          build_title
+          build_order_header
+        end
+        
+        def build_invoice_body
+         
+          pdf_writer.y = 600
+
+          Ruport::Renderer::Table.render_pdf { |r|
+            r.data = data
+            r.options.formatter = pdf_writer
+            r.options.table_width = options.body_width || 450
+          }
+
+        end
+
+        def build_invoice_footer
+         # footer
+          pdf_writer.open_object do |footer|
+            pdf_writer.save_state
+            pdf_writer.stroke_color! Color::RGB::Black
+            pdf_writer.stroke_style! ::PDF::Writer::StrokeStyle::DEFAULT
+            if options.comments  
+              
+              move_cursor_to 60
+
+              horizontal_line left_boundary + 20, right_boundary - 25
+
+              move_cursor -10 
+
+              add_text(options.comments,:justification => :center, 
+                                        :left => 0, :right => 0 )
+                                        
+            end
+
+            pdf_writer.restore_state
+            pdf_writer.close_object
+            pdf_writer.add_object(footer, :all_pages)
+          end
+        end
+
+        def finalize_invoice
+          output << pdf_writer.render
+        end
+
+      end 
+    end 
+  end  
+end
+
+module Ruport::Report::Invoice
+  def render_invoice(*args,&block)
+    Ruport::Renderer::Invoice.render_pdf(*args,&block)
+  end
+end
+

data/lib/ruport/util/report_manager.rb

@@ -0,0 +1,93 @@
+module Ruport
+  class ReportManager  
+
+    def self.add_model(*new_models)
+       self.models |= new_models
+    end   
+    
+    def self.add_report(*new_reports)
+      self.reports |= new_reports
+    end
+               
+    # Looks in reports first, then models.
+    # if there is a conflict, you are F'ed.
+    #
+    # just kidding, use models#find or reports#find
+    def self.[](name)     
+      reports.find { |r| r.name.eql?(name) } ||
+      models.find { |m| m.name.eql?(name) }
+    end
+  
+    def self.models
+      @models ||= []
+    end      
+    
+    def self.reports
+      @reports ||= []
+    end
+  
+    class << self
+      attr_writer :models 
+      attr_writer :reports 
+    end
+  
+  end          
+end
+
+if defined? ActiveRecord
+  class ActiveRecord::Base
+    def self.acts_as_managed_report
+      Ruport::ReportManager.add_model(self)
+    end     
+  end
+end          
+
+class Ruport::Report
+  def self.acts_as_managed_report
+    Ruport::ReportManager.add_report(self)
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME                        
+  
+  include Ruport     
+  
+  require "test/unit"
+  
+  # we'll autoregister this one  
+  class FakeModel
+    ReportManager.add_model(self)
+  end                          
+  
+  # we'll add these afterwards
+  class FakeModel2;end
+  class FakeModel3;end
+  
+  
+  class TestReportManager < Test::Unit::TestCase     
+     
+     def test_simple_usage
+        assert_equal [FakeModel], ReportManager.models
+        assert_equal FakeModel, ReportManager["FakeModel"]
+     end         
+     
+     def test_add_models_externally
+        klass = ReportManager.dup # we need to do this to make the tests work 
+                                  # no need in production code
+        assert_equal [FakeModel], klass.models        
+        
+        klass.add_model(FakeModel2)
+        assert_equal [FakeModel,FakeModel2], klass.models
+        
+        klass.add_model(FakeModel3)
+        assert_equal [FakeModel,FakeModel2, FakeModel3], klass.models
+        
+        # let's make sure we can still grab these by name (a string)
+        [FakeModel,FakeModel2,FakeModel3].each do |m|  
+          assert_equal m, klass[m.name]
+        end
+     end 
+     
+  end
+end
+  

data/lib/ruport/util.rb

@@ -0,0 +1,3 @@
+require "ruport/util/graph"
+require "ruport/util/invoice"
+require "ruport/util/report_manager"

data/test/init.rb

@@ -0,0 +1,7 @@
+require "test/unit"
+begin
+  require "rubygems"
+rescue LoadError
+  nil
+end
+require "ruport"

data/test/test_graph_renderer.rb

@@ -0,0 +1,105 @@
+require "test/init"
+require "ruport/util/graph"
+
+class MockGraphPlugin < Ruport::Formatter
+  renders :mock, :for => Ruport::Renderer::Graph
+  def prepare_graph 
+    output << "prepare"
+  end
+  def build_graph
+    output << "build"
+  end
+  def finalize_graph
+    output << "finalize"
+  end
+end
+
+
+class TestGraphRenderer < Test::Unit::TestCase
+  
+  def test_basics
+    out = Ruport::Renderer::Graph.render_mock do |r|
+      r.options do |l|
+        assert_equal :line, l.style
+      end
+    end
+
+    assert_equal("preparebuildfinalize",out)    
+  end
+
+end
+
+
+class TestSVGPlugin < Test::Unit::TestCase
+
+  def test_output
+    assert_not_nil Ruport::Renderer::Graph.render_svg { |r|
+      r.data = Ruport::Graph(:data => [[1,2,3],[4,5,6]])
+    }
+  end
+
+end
+
+class TestXMLSWFPlugin < Test::Unit::TestCase
+
+  def test_output
+  
+    expected = <<-EOS
+<chart>
+  <chart_type>line</chart_type>
+  <chart_data>
+    <row>
+      <null/>
+    </row>
+    <row>
+      <string>Region 0</string>
+      <number>1</number>
+      <number>2</number>
+      <number>3</number>
+    </row>
+    <row>
+      <string>Region 1</string>
+      <number>4</number>
+      <number>5</number>
+      <number>6</number>
+    </row>
+  </chart_data>
+</chart>
+EOS
+    assert_equal expected,
+    Ruport::Renderer::Graph.render_xml_swf { |r|
+      r.data = Ruport::Graph(:data => [[1,2,3],[4,5,6]])  
+    } 
+    
+    expected = <<-EOS
+<chart>
+  <chart_type>line</chart_type>
+  <chart_data>
+    <row>
+      <null/>
+    </row>
+    <row>
+      <string>Alpha</string>
+      <number>1</number>
+      <number>2</number>
+      <number>3</number>
+    </row>
+    <row>
+      <string>Beta</string>
+      <number>4</number>
+      <number>5</number>
+      <number>6</number>
+    </row>
+  </chart_data>
+</chart>
+EOS
+
+  graph = Ruport::Graph()
+  graph.add_line [1,2,3], :name => "Alpha"
+  graph.add_line [4,5,6], :name => "Beta"
+  
+  assert_equal expected, graph.to_xml_swf
+    
+  end
+
+end

data/test/test_invoice.rb

@@ -0,0 +1,29 @@
+require "test/init"
+require "ruport/util/invoice"
+
+class TestInvoice < Test::Unit::TestCase
+
+  def test_required_options         
+    assert_raises(RuntimeError) { Ruport::Renderer::Invoice.render_pdf }
+    
+    #hash form
+    assert_nothing_raised {
+      Ruport::Renderer::Invoice.render_pdf :data => Table(%w[a b c]) << [1,2,3],
+         :customer_info => "blah", :company_info => "also blah",
+         :order_info => "Incredibly Blah", :comments => "Super Blah"
+    }         
+    
+    #block form
+    assert_nothing_raised {
+      Ruport::Renderer::Invoice.render_pdf do |r|
+         r.data = Table(%w[a b c]) << [1,2,3]
+         r.customer_info = "blah"
+         r.company_info  = "also blah"
+         r.order_info    = "Incredibly Blah"  
+         r.comments      = "Super blah"
+      end     
+    }
+  end
+  
+  
+end  

data/test/test_report_manager.rb

@@ -0,0 +1,38 @@
+require "test/init"
+require "ruport/util/report_manager"
+   
+class Sample < Ruport::Report; def generate; "Hello Mike"; end; end
+class Sample2 < Ruport::Report; def generate; "Hello Joe"; end; end
+Sample.acts_as_managed_report
+Sample2.acts_as_managed_report  
+
+class FakeModel2;end
+class FakeModel3;end
+
+class TestReportManager < Test::Unit::TestCase
+   
+  def test_simple_usage  
+    assert_equal "Hello Mike", Ruport::ReportManager["Sample"].run
+    assert_equal "Hello Joe", Ruport::ReportManager["Sample2"].run 
+    assert_equal [ Sample, Sample2 ], Ruport::ReportManager.reports       
+  end   
+               
+  def test_add_models
+    # we need to do this to make the tests work,no need in production code
+    klass = Ruport::ReportManager.dup 
+
+    assert_equal [], klass.models        
+
+    klass.add_model(FakeModel2)
+    assert_equal [FakeModel2], klass.models
+
+    klass.add_model(FakeModel3)
+    assert_equal [FakeModel2, FakeModel3], klass.models
+
+    # let's make sure we can still grab these by name (a string)
+    [FakeModel2,FakeModel3].each do |m|  
+      assert_equal m, klass[m.name]
+    end
+  end  
+  
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: ruport-util
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-04-04 00:00:00 -04:00
+summary: A set of tools and helper libs for Ruby Reports
+require_paths: 
+- lib
+email: "  gregory.t.brown@gmail.com"
+homepage: http://code.rubyreports.org
+rubyforge_project: ruport
+description: ruport-util provides a number of utilities and helper libs for Ruby Reports
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Gregory Brown
+files: 
+- example/graph_report.rb
+- example/invoice_report.rb
+- example/managed_report.rb
+- lib/ruport
+- lib/ruport/util
+- lib/ruport/util.rb
+- lib/ruport/util/graph.rb
+- lib/ruport/util/invoice.rb
+- lib/ruport/util/report_manager.rb
+- test/init.rb
+- test/test_graph_renderer.rb
+- test/test_invoice.rb
+- test/test_report_manager.rb
+- Rakefile
+test_files: 
+- test/test_graph_renderer.rb
+- test/test_invoice.rb
+- test/test_report_manager.rb
+rdoc_options: 
+- --title
+- Ruport Documentation
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: scruffy
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.2
+    version: