rghost 0.7.4 → 0.8

data/lib/rghost/grid/style/border_lines.rb

@@ -0,0 +1,46 @@
+
+
+class RGhost::Grid::Style::BorderLines
+  
+  def set_style(grid)
+
+    grid.before_row do
+      
+      horizontal_line(:top,    :size => grid.width)
+      horizontal_line(:bottom,    :size => grid.width)
+    end
+
+    grid.before_column :only => 0 do
+      vertical_line_row
+    end
+    
+    grid.after_column do
+      vertical_line_row
+    end
+    
+    
+    grid.header.before_create do
+      line_width(0)
+      use_tag :bold
+      horizontal_line(:top, :size => grid.width)
+      horizontal_line(:bottom,:size => grid.width)
+    end
+    
+    grid.header.after_create { use_tag :normal }
+  
+
+    grid.header.before_column :only => 0 do
+      vertical_line_row
+    end
+    
+    grid.header.after_column do
+      vertical_line_row
+    end
+    
+    
+    
+    
+  end
+
+
+end

data/lib/rghost/grid/style/bottom_lines.rb

@@ -0,0 +1,30 @@
+
+
+class RGhost::Grid::Style::BottomLines
+  
+  def set_style(grid)
+
+    size=grid.header.size
+    grid.before_row do
+       horizontal_line(:bottom,:size => grid.width)
+
+    end
+    
+    grid.header.before_create do
+      line_width(0)
+      horizontal_line(:bottom,:size => grid.width)
+      use_tag :bold
+    end
+    
+    grid.header.after_create { use_tag :normal }
+      
+  
+
+    
+    
+    
+    
+  end
+
+
+end

data/lib/rghost/grid/style/old_forms.rb

@@ -0,0 +1,30 @@
+
+
+class RGhost::Grid::Style::OldForms
+  
+  def set_style(grid)
+
+    size=grid.header.size
+    grid.odd_row do
+      background_row(:size => size)
+
+    end
+    
+    grid.header.before_create do
+      line_width(0)
+      background_row(:size => size, :color => RGhost::ShapeContent::DEFAULT_OPTIONS[:color] )
+      use_tag :bold
+    end
+    
+    grid.header.after_create { use_tag :normal }
+      
+  
+
+    
+    
+    
+    
+  end
+
+
+end

data/lib/rghost/grid/style/style.rb

@@ -0,0 +1,8 @@
+
+module RGhost::Grid 
+  module Style
+    require 'grid/style/border_lines'
+    require 'grid/style/old_forms'
+    require 'grid/style/bottom_lines'
+  end
+end

data/lib/rghost/gs_alone.rb

@@ -1,15 +1,17 @@
-class GSAlone
+class RGhost::GSAlone #:nodoc:
   
-  def initialize(params)
+  def initialize(params,debug=false)
     @params=params.dup
     @params[0]=" "
+    @debug=debug
   end
   
   def run
     cmd=@params.join(" ")
-    r=system(RubyGhostConfig::GS[:path]+cmd)
-    puts RubyGhostConfig::GS[:path]+cmd
-    puts r
+    r=system(RGhost::Config::GS[:path]+cmd)
+    
+    puts RGhost::Config::GS[:path]+cmd if @debug
+    #puts r
     r
   end
   

data/lib/rghost/helpers.rb

@@ -1,11 +1,11 @@
-module Helpers
-  module HashKeyMethod
+module RGhost::UnlessHelpers #:nodoc:
+  module HashKeyMethod #:nodoc:
     def method_missing(method, *args)
-          self[method.to_sym]   
+      self[method.to_sym]   
     end
   end
   
-  class HashKeyMethodClass < Hash
+  class HashKeyMethodClass < Hash #:nodoc:
     include HashKeyMethod
   end
 

data/lib/rghost/horizontal_line.rb

@@ -1,28 +1,44 @@
 require "ps_object"
 require "units"
-#Cria uma linha horizontal na faixa corrente com alinhamento vertical variando em 
+#Creates horizontal line on the current row.
+class RGhost::HorizontalLine < RGhost::PsObject
+  
+  DEFAULT_OPTIONS={:start_in => :limit_left, :size => :area_x,
+    :border => RGhost::Border::DEFAULT_OPTIONS
+    
+  }
+ 
+#Examples
+#
+#Drawing line on middle
+#
+# doc.show "Foo Bar"
+# doc.horizontal_line :middle
 # 
-#   :top      # topo da faixa
-#   :middle   # meio da faixa
-#   :bottom   # base da faixa
-class HorizontalLine < PsObject
+#link:images/horizontal_line01.png
+#
+#Drawing line on bottom and customizing border attributes
+#
+# doc.show "Foo Bar"
+# doc.horizontal_line :bottom, :border => {:dash => [1,2,2,2], :color => :red}
+#
+#link:images/horizontal_line02.png
+#
+#Specifies size and where will start of line
+#
+# doc.show "Foo Bar"
+# doc.horizontal_line :top, :start_in => 2, :size => 5, :border => {:dash => [1,2,2,2], :color => :red}
+#
+#link:images/horizontal_line03.png
+
   
-  DEFAULT_OPTIONS={:start_in => :limit_left, :size => :area_x}
-  #Nova inst�ncia de HorizontalLine.
-  #
-  #No meio da faixa come�ando de limit_left da p�gina com tamanho da area_x
-  # h=HorizontalLine.new
-  #Iniciando da posi��o 3 at� a 5, no topo
-  # h=HorizontalLine.new(:top, :start_in => 3, :size => 2)
-  #Em um Document
-  # d=Document.new
-  # d.set HorizontalLine.new(:bottom)   
   def initialize(valign=:middle,options={})
     @options=DEFAULT_OPTIONS.dup.merge(options)
-    start_in=Units::parse(@options[:start_in])
-    size=Units::parse(@options[:size])
-    
-    super("#{start_in} #{size} horizontal_line_#{valign}")
+    start_in= RGhost::Units::parse(@options[:start_in])
+    size= RGhost::Units::parse(@options[:size])
+    border=RGhost::Border.new(@options[:border])
+    super("gsave #{border.ps }  #{start_in} #{size} horizontal_line_#{valign} grestore")
+    #super("#{start_in} #{size} horizontal_line_#{valign}")
   
   end
   

data/lib/rghost/how_to.rb

@@ -0,0 +1,75 @@
+#=Ruby Ghostscript engine - Document Builder
+#==About
+#RubyGhost (RGhost) is a library for document developers wanting a quick and easy 
+#way to generate pdf files. Notable features include: inserting images, 
+#vector drawing , font suppoort , EPS template support and multiple output formats. 
+#RGhost acts as Ruby a wrapper over the Ghostscript engine enriched by predefined 
+#set Postscript(ps) functions. For example:
+#
+#Ruby code you'll write: 
+#
+#  h=HorizontalLine.new :middle, :start_in => 3, :size => 2
+#
+#gets translated to the following Postscript function. Note how this is not actually 
+#raw Postscript, instead it makes use of a set of predefined functions shipped with Rghost. 
+#
+#  3 unit 2 unit exch gsave current_row row_height sqrt add moveto 0 rlineto stroke grestore
+#
+#Unless embarking into deep Postscript wizardry you don't need to be aware of this fact. 
+#Basically RGhost is a helper for creating of Postscript documents. 
+#The resulting Postscript document is rendered to the target format (usually pdf but not just) 
+#by invoking  Ghostscript the free Postscript interpreter. Ghostscript settings very 
+#a lot depending on your platform. Initially RGhost was developed for *nix environments 
+#where Ghostscript is (almost always) native and used as a printing filter (CUPS, LPRng etc) 
+#and also as a document format converter. So it became necessary to make an interface 
+#between Ruby and Ghostscript in two ways:
+#
+#* gsapi     - based on the exchange of data between Ruby and Ghostscript via rgengine.so using gslib.so.8 or gslib-esp.so.8 
+#* gsparams  - In this mode RGhost just pass parameters to the Ghostscript framework.1.1 Files
+#	
+#During the conversion of the postscript code to the desired format 4 files are created, 3 of them being temporary.
+#
+#====Input
+#The input file is a pure postscript file with a .rgin extension that will be automatically removed after the conversion process, even if errors show up.
+#
+#====Errors
+#Using a .rgerr extension, its content are the errors generated by ghostscript. It'll be deleted after the conversion. The content of the file is available on the errors variable of the RubyGhostEngine class.
+#
+#====Log
+#The log file is set using the option :logfile of the RubyGhostEngine class, appending all logs to it. Disabled by default.
+#
+#====Output
+#The output files will have the extension passed to the RGhost::Document#render method. For multi page formats it will return an array of files. These files aren't deleted automatically, meaning that the developer will have to deal with them.
+#====Author
+#Shairon Toledo  shairon.toledo(at)gmail.com http://www.hashcode.eti.br Brazil Jun/2008
+#====Thanks
+#Dee Zsombor[http://deezsombor.com] and Mereghost
+#   
+#==Installation and Setup
+#====Ghostscript
+#You need to have ESP Ghostscript 8.xx or GNU Ghostscript 8.xx installed
+#
+#=====Non-coupled installation: *gsparams* (recommended)
+#This is the simplest setup, you'll have to dowload and install the Ghostscript framework(http://www.cs.wisc.edu/~ghost/). 
+#Rhgost will invoke the ghostscript interpreter in the background to generate the desired output.
+#
+#===== Coupled installation: *gslib* (Linux only) 
+#You can use the native ghostrcipt interface via the  gs-esp and libgs-esp8 (libgs-esp.so) packages. This may be already set up for you on Linux or you'll have to compile ghostscript
+#=====Installation via remote gem
+#  gem install rghost
+#  
+#=====Rails plugin installation 
+#Gets last version in RubyForge[http://rubyforge.org/frs/?group_id=3796&release_id=18301] unpack on RAILS_ROOT/lib
+#====Setup
+#Look at RGhost::Config
+#==Namespace 
+#You can work either full namespace of including RGhost module. 
+#=====Full namespace
+# doc=RGhost::Document.new
+#=====Including module RGhost
+# include RGhost
+# doc=Document.new
+
+class RGhost::HowTo
+  
+end

data/lib/rghost/image.rb

@@ -1,6 +1,6 @@
 require "ps_object"
-#SuperClass de GIF e JPEG.
-class Image < PsObject
+#Super class of GIF and JPEG.
+class RGhost::Image < RGhost::PsObject
   DEFAULT_OPTIONS={:x=> :limit_left, :y=> 1, :zoom => 100, :rotate => 0}
   
   def initialize(image_path,options={})
@@ -9,14 +9,14 @@ class Image < PsObject
     @file=image_path
   end
   
-  #Cria uma imagem pela extens�o. Aceita gif, jpeg, jpg e eps
-  def Image.for(path,options={})
+  #Facade method for load image by file extension. Uses Eps, Gif and Jpeg class. Accepts gif, jpeg, jpg and eps
+  def self.for(path,options={})
     
     clazz=case path
-      when /gif$/i: Gif
-      when /jpe?g$/i: Jpeg
-      when /(eps|template)$/i :Eps
-      else raise NameError.new("Format not supported")
+      when /gif$/i: RGhost::Gif
+      when /jpe?g$/i: RGhost::Jpeg
+      when /(eps|template)$/i : RGhost::Eps
+      else raise NameError.new("Unsupported format")
     end
     
     clazz.new(path,options)

data/lib/rghost/jpeg.rb

@@ -3,9 +3,22 @@ require "graphic"
 require "cursor"
 require "variable"
 require "image"
-# Carrega uma imagem no formato Jpeg
-#  i=Jpeg.new("/junk/any.jpg", :y=> 15,:x => 3, :rotate => 90)
-class Jpeg < Image
+  #Loads JPEG image from file
+  #===Examples
+  # doc=Document.new
+  # doc.set Jpeg.new "../public/images/button.jpg", :x => 10, :y => 3
+  #Using Image.for facade 
+  # doc.set Image.for "../public/images/button.jpg", :x => 10, :y => 3
+  #Using PsFacade or Document 
+  # doc.image "images/button.jpg", :x => 10, :y => 3
+  #Using Zoom of the 200 percent
+  # doc.image "images/button.jpg", :zoom => 200
+  #===Options
+  #
+  #* <tt>:x and :y</tt> - Coordinates to position.
+  #* <tt>:rotate</tt> - Angle to image rotation if there is one.
+  #* <tt>:zoom</tt> - Resize proportionally the image
+class RGhost::Jpeg < RGhost::Image
 
 
 
@@ -13,12 +26,12 @@ class Jpeg < Image
     #x=Units::parse( @options[:x] )
     #y=Units::parse( @options[:y] )
     
-    g=Graphic.new 
-    g.set Cursor.translate(@options)
+    g=RGhost::Graphic.new 
+    g.set RGhost::Cursor.translate(@options)
       #set Cursor.translate()
-    g.set Cursor.rotate(@options[:rotate])
-    g.set Variable.new(:zoom,@options[:zoom]/100.0)
-    g.set PsObject.new("(#{@file}) viewJPEG")
+    g.set RGhost::Cursor.rotate(@options[:rotate])
+    g.set RGhost::Variable.new(:zoom,@options[:zoom]/100.0)
+    g.set RGhost::PsObject.new("(#{@file}) viewJPEG")
     g
 
   end

data/lib/rghost/line.rb

@@ -1,35 +1,84 @@
 require "ps_object"
 require "point"
 
-#Define lineto ou rlineto
-class Line < PsObject
+#Creates straight lines 
+class RGhost::Line < RGhost::PsObject
   DEFAULT_POINT={:x => :limit_left , :y => :current_row}
   
-  #Desenha a linha do ponto correte ao ponto informado
-  # d=Document.new
-  # d.set Cursor.moveto(:x=> 2, :y=> 7)
-  # d.set Line.lineto(:x => 10, :y => 2) #uma linha diagonal para baixo
-  def Line.lineto(point={})
+  #Draw line the one pont until another, the first point is creates by moveto and de last point using the method lineto.
+  #===Examples
+  # doc=Document.new
+  # doc.moveto :x => 2, :y => 3
+  # doc.lineto :x => 5, :y => 2
+  # 
+  #link:images/line01.png 
+  #
+  # doc=Document.new
+  # doc.moveto :x => 2, :y => 3
+  # doc.lineto :x => 4, :y => 4 
+  # 
+  #link:images/line02.png 
+  #
+  # doc=Document.new
+  # doc.border :color => '#AAFA49', :width => 4
+  # doc.moveto :x => 2, :y => 3
+  # doc.lineto :x => 4, :y => 1 
+  # 
+  #link:images/line03.png 
+  #
+  # doc=Document.new
+  # doc.border :color => '#49AAFA', :width => 1
+  # doc.moveto :x => 2, :y => 3
+  # doc.lineto :x => 4, :y => 1 
+  # doc.moveto :x => 2, :y => 3
+  # doc.lineto :x => 2, :y => 1 
+  # 
+  #link:images/line04.png 
+  #
+  #Using graphic state to close path shape
+  #
+  # doc=Document.new
+  # doc.graphic do
+  #   doc.border :color => '#49AAFA', :width => 1
+  #   doc.moveto :x => 2, :y => 3
+  #   doc.lineto :x => 4, :y => 1 
+  #   doc.lineto :x => 2, :y => 1 
+  #   doc.shape_content :color => "#F0FFFF"
+  #   doc.closepath
+  # end
+  # 
+  #link:images/line05.png 
+  def self.lineto(point={})
   
-    Line.make_command(:lineto,point)
+    RGhost::Line.make_command(:lineto,point)
   
   end
-  #Desenha a linha do ponto correte ao ponto relativo informado.
-  # d=Document.new
-  # d.set Cursor.moveto(:x=> 2, :y=> 7)
-  # d.set Line.rlineto(:x => 10, :y => 2) #uma linha diagonal para cima
-  def Line.rlineto(point={})
-    Line.make_command(:rlineto,point)
+  #(Relative lineto) Draw straingh line in the same manner as lineto, but from current point to distance for next :x and :y. That is, rlineto constructs a line from (x, y) to (x + dx, y + dy) and makes (x + dx, y + dy) the new current point. 
+  #
+  #===Examples
+  # doc=Document.new
+  # doc.moveto  :x => 2, :y => 1
+  # doc.rlineto :x => 3, :y => 2
+  # 
+  #link:images/line06.png 
+  #
+  # doc=Document.new
+  # doc.moveto  :x => 2, :y => 1
+  # doc.rlineto :x => 3, :y => 2
+  # doc.rlineto :x => 0, :y => -2
+  #link:images/line07.png 
+  def self.rlineto(point={})
+    line=RGhost::Line.make_command(:rlineto,point)
   
   end
   
   
   private 
-  def Line.make_command(command,point={})
+  def self.make_command(command,point={})
 
     p=DEFAULT_POINT.dup.merge(point)
-    p=Point.new(p[:x],p[:y])
-    PsObject.new "#{p.ps}#{command}"
+    p=RGhost::Point.new(p[:x],p[:y])
+    RGhost::PsObject.new "#{p.ps}#{command}"
   end
   
 end

data/lib/rghost/line_width.rb

@@ -1,12 +1,23 @@
 require "ps_object"
-#Define a largura da borda. Valor 1 � o padr�o Postscript mas a mais fina � 0
-class LineWidth < PsObject
-  #Nova inst�ncia de LineWidth
-  # d=Document.new
-  # d.before_page_create do
-  #   set LineWidth.new(0)
-  # end
-  def initialize(value=1)
+#Sets the line width parameter in the graphics state.
+class RGhost::LineWidth < RGhost::PsObject
+  
+  #Examples
+  #The more tiny line
+  # doc=Document.new
+  # doc.line_width 0 
+  #
+  #link:images/line_width01.png 
+  #
+  # doc.line_width 1 
+  #
+  #link:images/line_width02.png 
+  #
+  # doc.line_width 2 
+  #
+  #link:images/line_width03.png 
+  #
+  def initialize(value=0.3)
     @value=value
   end 
   

data/lib/rghost/load.rb

@@ -1,34 +1,36 @@
 require "ps_object"
-module Load
-
-  def Load.library(name, type=:ps)
+module RGhost::Load
+  #Loads library
+  def self.library(name, type=:ps)
     #PsObject.new File.open(File.dirname(__FILE__)+File::SEPARATOR+type.to_s+File::SEPARATOR+name.to_s+"."+type.to_s).readlines.join("")
     
-    PsObject.new("(#{name.to_s}.#{type}) runlibfile\n")
+   RGhost::PsObject.new("(#{name.to_s}.#{type}) runlibfile\n")
       
   end
   
-  def Load.rg_enviroment
-    PsObject.new do
-      raw Load.library(:basic)
-      raw Load.library(:cursor)
-      raw Load.library(:rectangle)
-      raw Load.library(:font)
-      raw Load.library(:textarea)
-      raw Load.library(:horizontal_line)
-      raw Load.library(:vertical_line)
-      raw Load.library(:callbacks)
-      raw Load.library(:show)
-      raw Load.library(:eps)
-      raw Load.library(:jpeg)
-      raw Load.library(:gif)
-      raw Load.library(:begin_document)
-      raw Load.library(:datagrid)
+  def self.rg_enviroment
+    RGhost::PsObject.new do
+      raw RGhost::Load.library(:basic)
+      raw RGhost::Load.library(:cursor)
+      raw RGhost::Load.library(:rectangle)
+      raw RGhost::Load.library(:font)
+      raw RGhost::Load.library(:textarea)
+      raw RGhost::Load.library(:horizontal_line)
+      raw RGhost::Load.library(:vertical_line)
+      raw RGhost::Load.library(:callbacks)
+      raw RGhost::Load.library(:show)
+      raw RGhost::Load.library(:eps)
+      raw RGhost::Load.library(:jpeg)
+      raw RGhost::Load.library(:gif)
+      raw RGhost::Load.library(:begin_document)
+      raw RGhost::Load.library(:datagrid)
+      raw RGhost::Load.library(:text)
+      raw RGhost::Load.library(:frame)
       
     end
   end
-  
-  def Load.binary(path)
+  #Loads binary library
+  def self.binary(path)
       File.open(path).readlines.join
   
   end

data/lib/rghost/newpath.rb

@@ -5,15 +5,16 @@ require "point"
 require "point"
 require "line_width"
 
-#Cria um bloco que cria um novo path sem alterar o path corrente. O path v�lido apenas para o escopo do bloco. Contudo fecha o path(closepath) ao fim do bloco.
-#   doc=Document.new
-#   doc.newpath do
-#     set Arc.new(:x => 10, :y => 10, :radius => 100)
-#   end 
-class NewPath < PsObject
+#Initializes the current path to be empty, causing the current point to become undefined. 
+class RGhost::NewPath < RGhost::PsObject
  
+  def initialize(&block)
+    @body=RGhost::PsFacade.new(&block)
+    
+  end
+  
   def ps
-      "newpath #{super} closepath"
+      "newpath #{@body} closepath"
   end