documatic 0.0.1 → 0.0.2

data/README

@@ -1,9 +1,9 @@
 = Documatic
 
-Documatic is an OpenDocument processor for Ruby. It can be used to
-produce attractive printable documents such as database reports,
-invoices, letters, faxes and more. Both the data inputs and the
-printable output are very flexible and easy to configure.
+Documatic is an OpenDocument extension for Ruby Reports (Ruport). It
+is a template-driven formatter that can be used to produce attractive
+printable documents such as database reports, invoices, letters, faxes
+and more.
 
 
 == Installation
@@ -13,6 +13,22 @@ Documatic can be installed via Rubygems.
   % gem install documatic
 
 
+== Usage
+
+Documatic is a Ruport extension, so it is loaded like this:
+
+  require 'rubygems'
+  require 'ruport'
+  require 'ruport/extensions'
+
+Documatic will then be available as a formatter for your Ruport tables, groups and groupings:
+
+  data.to_odt_template(:template => 'path/filename.odt',
+                       :output   => 'output-path/filename.odt')
+
+The wiki has more documentation and examples, plus a simple tutorial.
+
+
 == Licence
 
 Documatic is (p) Public Domain 2007, no rights reserved.
@@ -22,8 +38,20 @@ Documatic comes with no warranty whatsoever.
 
 == Support
 
-Further information is available on the Documatic homepage at
-http://documatic.240gl.org.
+See the Documatic Trac page at
+http://stonecode.svnrepository.com/documatic/trac.cgi.  The wiki is
+the main source of information for end-users.  The tracking system is
+where bug reports should be filed.
+
+Users can discuss Documatic on the Ruby Reports mailing list at
+http://groups.google.com/group/ruby-reports.
+
+The Subversion repository for Documatic is at
+http://stonecode.svnrepository.com/svn/documatic.
+
+The Rubyforge project page for Documatic is at
+http://rubyforge.org/projects/documatic.  The Documatic rubygem is
+distributed from here.
 
-The Documatic project page (including tracker) is at
-http://rubyforge.org/projects/documatic.
+For any other enquiries please contact Dave Nelson (urbanus at 240gl
+dot org).

data/lib/documatic/component.rb

@@ -3,7 +3,7 @@ require 'erb'
 module Documatic
   class Component
     include ERB::Util
-    include Documatic::Helper
+    include Documatic::OpenDocumentText::Helper
     
     attr_accessor :erb
     
@@ -46,7 +46,7 @@ module Documatic
     # intended to be called directly by client applications: it is
     # called automatically by Documatic::Template after processing.
     def merge_partial_styles
-      cache = Documatic::Partial.cache_by_prefix
+      cache = Documatic::OpenDocumentText::Partial.cache_by_prefix
       if cache.length > 0
         styles = self.xml.root.elements['office:automatic-styles']
         if styles

data/lib/documatic/formatter/open_document.rb

@@ -0,0 +1,27 @@
+require 'fileutils'
+require 'ruport'
+
+module Documatic::Formatter
+
+  class OpenDocumentText < Ruport::Formatter
+    PROCESSOR = Documatic::OpenDocumentText::Template
+    renders :odt_template, :for => [ Ruport::Renderer::Table, Ruport::Renderer::Group,
+                                     Ruport::Renderer::Grouping ]
+    
+    def build
+      PROCESSOR.process_template(:data => data, :options => options)
+    end
+    alias_method :build_table_body, :build  # for Ruport::Renderer::Table
+    alias_method :build_group_body, :build  # for Ruport::Renderer::Group
+    alias_method :build_grouping_body, :build # for Ruport::Renderer::Grouping
+    
+  end
+
+  # Coming soon
+#   class OpenDocumentSpreadsheet < OpenDocumentText
+#     PROCESSOR = Documatic::OpenDocumentSpreadsheet::Template
+#     renders :ods_template, :for => [ Ruport::Renderer::Table, Ruport::Renderer::Group,
+#                                      Ruport::Renderer::Grouping ]
+#   end    
+
+end

data/lib/documatic/init.rb

@@ -0,0 +1,4 @@
+class RuportDocumaticLoader < GemPlugin::Plugin "/ruport/documatic"
+  require 'documatic'
+  require 'documatic/formatter/open_document'
+end

data/lib/documatic/open_document_text/helper.rb

@@ -0,0 +1,55 @@
+require 'erb'
+
+module Documatic
+  module OpenDocumentText
+    module Helper
+
+      include ERB::Util
+      
+
+      # Inserts a paragraph (<text:p>) containing the provided content;
+      # or nothing if no content is provided.  This helper should be
+      # invoked from within "Ruby Block" because paragraphs are
+      # block-level elements.
+      # 
+      # Note that the content is not escaped by default because you
+      # might want to include other tags in the content.  You should use
+      # ERB::Util.h() to escape any content that could possibly contain
+      # XML characters.
+      def para(stylename, content = nil)
+        end_element = ( content ? ">#{content}</text:p>" : "/>" )
+        %Q(<text:p text:style-name="#{stylename}"#{end_element})
+      end
+
+      # Inserts a text span (<text:span>) containing the provided
+      # content.  This helper should be invoked from within "Ruby
+      # Literal" because the tag is a text-level element that shouldn't
+      # be escaped.  However the content is escaped.
+      def span(stylename, content)
+        %Q(<text:span text:style-name="#{stylename}">#{ERB::Util.h(content)}</text:span>)
+      end
+
+
+      # Inserts a partial into the document at the chosen position.
+      # This helper should be invoked from within "Ruby Block" because
+      # it inserts unescaped block-level material in the current
+      # template.
+      # 
+      # The +assigns+ hash is passed through to the partial for binding.
+      # 
+      # This method will add the provided partial to the
+      # Documatic::Partial cache if it hasn't yet been loaded; or if it
+      # has been loaded then the existing partial will be re-used.
+      def partial(filename, *assigns)
+        if Documatic::OpenDocumentText::Partial.cache.has_key?(filename)
+          p = Documatic::OpenDocumentText::Partial.cache[filename]
+        else
+          p = Documatic::OpenDocumentText::Partial.new(filename)
+          Documatic::OpenDocumentText::Partial.add_partial(filename, p)
+        end
+        p.process(*assigns)
+      end
+
+    end
+  end
+end

data/lib/documatic/{partial.rb → open_document_text/partial.rb}

@@ -1,7 +1,7 @@
 require 'rexml/document'
 
-module Documatic
-  class Partial < Documatic::Template
+module Documatic::OpenDocumentText
+  class Partial < Template
 
     attr_accessor :content
     attr_accessor :filename
@@ -35,13 +35,13 @@ module Documatic
     end
 
     def process(local_assigns = {})
-      self.zip_file.find_entry('documatic/partial') || self.compile
+      self.jar.find_entry('documatic/partial') || self.compile
       @content = Documatic::Component.new( self.content_erb )
       @content.process(local_assigns)
     end
 
     def compile
-      doc = REXML::Document.new( self.zip_file.read('content.xml') )
+      doc = REXML::Document.new( self.jar.read('content.xml') )
       style_names = Hash.new
 
       # Gather all auto style names from <office:automatic-styles>
@@ -60,16 +60,16 @@ module Documatic
       end
 
       # Create 'documatic/partial/' in zip file
-      self.zip_file.find_entry('documatic/partial') || self.zip_file.mkdir('documatic/partial')
+      self.jar.find_entry('documatic/partial') || self.jar.mkdir('documatic/partial')
       
       # Save the prefix in documatic/partial.txt
-      self.zip_file.get_output_stream('documatic/partial/partial.txt') do |f|
+      self.jar.get_output_stream('documatic/partial/partial.txt') do |f|
         f.write self.prefix
       end
 
       # Set @styles, & save it in documatic/styles.xml
       @styles = doc.root.elements['office:automatic-styles']
-      self.zip_file.get_output_stream('documatic/partial/styles.xml') do |f|
+      self.jar.get_output_stream('documatic/partial/styles.xml') do |f|
         f.write @styles.to_s
       end
 
@@ -78,7 +78,7 @@ module Documatic
       body_text.elements.delete('text:sequence-decls')
       body_text.elements.delete('office:forms')
       @content_erb = self.erbify( (body_text.elements.to_a.collect do |e| e.to_s ; end ).join )
-      self.zip_file.get_output_stream('documatic/partial/content.erb') do |f|
+      self.jar.get_output_stream('documatic/partial/content.erb') do |f|
         f.write @content_erb
       end
 
@@ -89,8 +89,8 @@ module Documatic
     
     def prefix
       if not @prefix
-        if self.zip_file.find_entry('documatic/partial/partial.txt')
-          @prefix = self.zip_file.read('documatic/partial/partial.txt')
+        if self.jar.find_entry('documatic/partial/partial.txt')
+          @prefix = self.jar.read('documatic/partial/partial.txt')
         else
           @prefix = File.basename(self.filename, '.odt').gsub(/[^A-Za-z0-9_]/, '_')
         end
@@ -100,8 +100,8 @@ module Documatic
 
     def content_erb
       if not @content_erb
-        if self.zip_file.find_entry('documatic/partial/content.erb')
-          self.zip_file.read('documatic/partial/content.erb')
+        if self.jar.find_entry('documatic/partial/content.erb')
+          self.jar.read('documatic/partial/content.erb')
         else
           self.compile
         end
@@ -111,8 +111,8 @@ module Documatic
 
     def styles
       if not @styles
-        if self.zip_file.find_entry('documatic/partial/styles.xml')
-          @styles = REXML::Document.new( self.zip_file.read('documatic/partial/styles.xml') ).root
+        if self.jar.find_entry('documatic/partial/styles.xml')
+          @styles = REXML::Document.new( self.jar.read('documatic/partial/styles.xml') ).root
         else
           self.compile
         end

data/lib/documatic/{template.rb → open_document_text/template.rb}

@@ -2,14 +2,15 @@ require 'rexml/text'
 require 'rexml/attribute'
 require 'zip/zip'
 require 'erb'
+require 'fileutils'
 
-module Documatic
+module Documatic::OpenDocumentText
   class Template
     include ERB::Util
     
     attr_accessor :content
     attr_accessor :styles
-    attr_accessor :zip_file
+    attr_accessor :jar
     # The raw contents of 'content.xml'.
     attr_accessor :content_raw
     # Compiled text, to be written to 'content.erb'
@@ -57,7 +58,7 @@ module Documatic
         require 'action_view/helpers/number_helper'
         require 'action_view/helpers/text_helper'
 
-        [self, Documatic::Partial].each do |klass|
+        [self, Documatic::OpenDocumentText::Partial].each do |klass|
           klass.class_eval do
             include ActionView::Helpers::NumberHelper
             include ActionView::Helpers::TextHelper
@@ -65,23 +66,41 @@ module Documatic
         end
       end
 
+      def process_template(args, &block)
+        if args[:options] && args[:options].template && args[:options].output
+          output_dir = File.dirname(args[:options].output)
+          File.directory?(output_dir) || FileUtils.mkdir_p(output_dir)
+          FileUtils.cp(args[:options].template, args[:options].output)
+          template = self.new(args[:options].output)
+          template.process :data => args[:data], :options => args[:options]
+          template.save
+          if block
+            block.call(template)
+            template.save
+          end
+          template.close
+        else
+          raise ArgumentError, 'Need to specify both :template and :output in options'
+        end
+      end
+            
     end  # class << self
     
     def initialize(filename)
       @filename = filename
-      @zip_file = Zip::ZipFile.open(@filename)
+      @jar = Zip::ZipFile.open(@filename)
       return true
     end
     
     def process(local_assigns = {})
       # Compile this template, if not compiled already.
-      self.zip_file.find_entry('documatic/master') || self.compile
+      self.jar.find_entry('documatic/master') || self.compile
       # Process the styles (incl. headers and footers).
       # This is conditional because partials don't need styles.erb.
-      @styles = Documatic::Component.new( self.zip_file.read('documatic/master/styles.erb') )
+      @styles = Documatic::Component.new( self.jar.read('documatic/master/styles.erb') )
       @styles.process(local_assigns)
       # Process the main (body) content.
-      @content = Documatic::Component.new( self.zip_file.read('documatic/master/content.erb') )
+      @content = Documatic::Component.new( self.jar.read('documatic/master/content.erb') )
       @content.process(local_assigns)
       @content.merge_partial_styles
     end
@@ -89,36 +108,36 @@ module Documatic
     def save
       # Gather all the styles from the partials, add them to the master's styles.
       # Put the body into the document.
-      self.zip_file.get_output_stream('content.xml') do |f|
+      self.jar.get_output_stream('content.xml') do |f|
         f.write self.content.to_s
       end
 
       if self.styles
-        self.zip_file.get_output_stream('styles.xml') do |f|
+        self.jar.get_output_stream('styles.xml') do |f|
           f.write self.styles.to_s
         end
       end
     end
 
     def close
-      self.zip_file.close
+      self.jar.close
     end
     
     def compile
       # Read the raw files
-      @content_raw = self.zip_file.read('content.xml')
-      @styles_raw = self.zip_file.read('styles.xml')
+      @content_raw = self.jar.read('content.xml')
+      @styles_raw = self.jar.read('styles.xml')
       
       @content_erb = self.erbify(@content_raw)
       @styles_erb = self.erbify(@styles_raw)
 
       # Create 'documatic/master/' in zip file
-      self.zip_file.find_entry('documatic/master') || self.zip_file.mkdir('documatic/master')
+      self.jar.find_entry('documatic/master') || self.jar.mkdir('documatic/master')
       
-      self.zip_file.get_output_stream('documatic/master/content.erb') do |f|
+      self.jar.get_output_stream('documatic/master/content.erb') do |f|
         f.write @content_erb
       end
-      self.zip_file.get_output_stream('documatic/master/styles.erb') do |f|
+      self.jar.get_output_stream('documatic/master/styles.erb') do |f|
         f.write @styles_erb
       end
     end
@@ -134,7 +153,7 @@ module Documatic
     end
 
     # Massage OpenDocument XML into ERb.  (This is the heart of the compiler.)
-    def erbify(code, escape = true)
+    def erbify(code)
       # First gather all the ERb-related derived styles
       remaining = code
       styles = {'Ruby_20_Code' => 'Code', 'Ruby_20_Value' => 'Value',
@@ -170,7 +189,7 @@ module Documatic
       # 11. ROW_END     End table row (incl. covered rows) ?
       #
       # "?": optional, might not occur every time
-      re_erb = /(<table:table-row><table:table-cell [^>]+>)?(<text:list-item>)?(<text:p [^>]+>)?(<\/text:span>)?<text:span text:style-name="(#{styles.keys.join '|'})">(([^<]*|<text:line-break\/>|<text:tab\/>)+)<\/text:span>(<text:span [^>]+>)?(<\/text:p>)?(<\/text:list-item>)?(<\/table:table-cell>(<table:covered-table-cell\/>)*<\/table:table-row>)?/
+      re_erb = /(<table:table-row[^>]*><table:table-cell [^>]+>)?(<text:list-item>)?(<text:p [^>]+>)?(<\/text:span>)?<text:span text:style-name="(#{styles.keys.join '|'})">(([^<]*|<text:line-break\/>|<text:tab\/>)+)<\/text:span>(<text:span [^>]+>)?(<\/text:p>)?(<\/text:list-item>)?(<\/table:table-cell>(<table:covered-table-cell\/>)*<\/table:table-row>)?/
 
       # Then search for all text using those styles
       while remaining.length > 0
@@ -179,13 +198,6 @@ module Documatic
         
         if md
           
-          ###       TESTING ONLY
-          #          puts "#{md[ERB_CODE]}:"
-          #          for i in 1 ... md.size do
-          #            puts "\t#{i}: #{md[i]}"
-          #          end
-          #          puts ""
-          
           result += md.pre_match
           
           match_code = false
@@ -212,7 +224,7 @@ module Documatic
               match_para = true
             end
           else  # style is Value or Literal
-            if (not escape) || (styles[md[TYPE]] == 'Literal')
+            if styles[md[TYPE]] == 'Literal'
               delim_start = '<%= ' ; delim_end = ' %>'
             else
               delim_start = '<%= ERB::Util.h(' ; delim_end = ') %>'
@@ -245,9 +257,6 @@ module Documatic
               result += md[SPAN_START]
             end
           end
-          #         if md[SPAN_START] and not match_span
-          #           result += md[SPAN_START]
-          #         end
           
           result += "#{delim_start}#{self.unnormalize md[ERB_CODE]}#{delim_end}"
           
@@ -265,10 +274,6 @@ module Documatic
             end
           end
 
-          #         if md[SPAN_END] and not match_span
-          #           result += md[SPAN_END]
-          #         end
-          
           if md[PARA_END] and not match_para
             result += md[PARA_END]
           end
@@ -294,10 +299,3 @@ module Documatic
 
   end
 end
-
-# Force REXML to use double-quotes (consistent with OOo).
-REXML::Attribute.class_eval do
-  def to_string
-    %Q[#@expanded_name="#{to_s().gsub(/"/, '&quot;')}"]
-  end
-end

data/lib/documatic.rb

@@ -1,7 +1,29 @@
-require 'documatic/helper'
-require 'documatic/template'
+require 'documatic/open_document_text/helper'
+require 'documatic/open_document_text/template'
 require 'documatic/component'
-require 'documatic/partial'
+require 'documatic/open_document_text/partial'
 
+
+# The module "Documatic" is the namespace for the other modules and
+# classes in this project.  It also contains some convenience methods.
 module Documatic
+  class << self
+
+    # Short-cut method for including a helper in
+    # OpenDocumentText::Template.
+    def text_helper(helper_module)
+      Documatic::Component.class_eval do
+        include helper_module
+      end
+    end
+
+  end  # class << self
+end
+
+
+# Force REXML to use double-quotes (consistent with OOo).
+REXML::Attribute.class_eval do
+  def to_string
+    %Q[#@expanded_name="#{to_s().gsub(/"/, '&quot;')}"]
+  end
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.2
 specification_version: 1
 name: documatic
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2007-05-16 00:00:00 +10:00
-summary: Documatic is a Ruby OpenDocument processor for preparing documents and reports.
+  version: 0.0.2
+date: 2007-06-15 00:00:00 +10:00
+summary: Documatic is an OpenDocument extension for Ruby Reports (Ruport). It is a template-driven formatter that can be used to produce attractive printable documents such as database reports, invoices, letters, faxes and more.
 require_paths: 
 - lib
 email: urbanus@240gl.org
-homepage: http://documatic.240gl.org
+homepage: http://stonecode.svnrepository.com/documatic/trac.cgi
 rubyforge_project: documatic
 description: 
-autorequire: 
+autorequire: init.rb
 default_executable: 
 bindir: bin
 has_rdoc: true
@@ -32,18 +32,24 @@ files:
 - lib
 - lib/documatic
 - lib/documatic.rb
-- lib/documatic/template.rb
 - lib/documatic/component.rb
-- lib/documatic/helper.rb
-- lib/documatic/partial.rb
+- lib/documatic/open_document_text
+- lib/documatic/open_document_text/helper.rb
+- lib/documatic/open_document_text/partial.rb
+- lib/documatic/open_document_text/template.rb
+- lib/documatic/formatter
+- lib/documatic/formatter/open_document.rb
+- lib/documatic/init.rb
 - tests
 - README
 test_files: []
 
-rdoc_options: []
-
-extra_rdoc_files: []
-
+rdoc_options: 
+- --main
+- README
+- --inline-source
+extra_rdoc_files: 
+- README
 executables: []
 
 extensions: []
@@ -60,3 +66,21 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.9.1
     version: 
+- !ruby/object:Gem::Dependency 
+  name: gem_plugin
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruport
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 

data/lib/documatic/helper.rb

@@ -1,53 +0,0 @@
-require 'erb'
-
-module Documatic
-  module Helper
-
-    include ERB::Util
-    
-
-    # Inserts a paragraph (<text:p>) containing the provided content;
-    # or nothing if no content is provided.  This helper should be
-    # invoked from within "Ruby Block" because paragraphs are
-    # block-level elements.
-    # 
-    # Note that the content is not escaped by default because you
-    # might want to include other tags in the content.  You should use
-    # ERB::Util.h() to escape any content that could possibly contain
-    # XML characters.
-    def para(stylename, content = nil)
-      end_element = ( content ? ">#{content}</text:p>" : "/>" )
-      %Q(<text:p text:style-name="#{stylename}"#{end_element})
-    end
-
-    # Inserts a text span (<text:span>) containing the provided
-    # content.  This helper should be invoked from within "Ruby
-    # Literal" because the tag is a text-level element that shouldn't
-    # be escaped.  However the content is escaped.
-    def span(stylename, content)
-      %Q(<text:span text:style-name="#{stylename}">#{ERB::Util.h(content)}</text:span>)
-    end
-
-
-    # Inserts a partial into the document at the chosen position.
-    # This helper should be invoked from within "Ruby Block" because
-    # it inserts unescaped block-level material in the current
-    # template.
-    # 
-    # The +assigns+ hash is passed through to the partial for binding.
-    # 
-    # This method will add the provided partial to the
-    # Documatic::Partial cache if it hasn't yet been loaded; or if it
-    # has been loaded then the existing partial will be re-used.
-    def partial(filename, *assigns)
-      if Documatic::Partial.cache.has_key?(filename)
-        p = Documatic::Partial.cache[filename]
-      else
-        p = Documatic::Partial.new(filename)
-        Documatic::Partial.add_partial(filename, p)
-      end
-      p.process(*assigns)
-    end
-
-  end
-end