rghost 0.7.4 → 0.8

data/lib/rghost/convert.rb

@@ -1,17 +1,36 @@
-#Converte PDF para outro formato
-class Convert
+# Convert PDF file to another format using commom render parameters of the Engine
+# A additional parameter for this method is :range. Below someone examples:
+# 
+# ====Only cover page
+#  Convert.new("/dir/myfile.pdf").to :jpeg, :filename => "/tmp/test.jpg"
+# 
+# ====One page per file
+# It's generate file with pattern test_0001.png, test_0002.png, etc
+#  Convert.new("/dir/myfile.pdf").to :png, :multipage => true, :filename => "/tmp/test.png"
+# 
+# ====One page per file with page range
+#  Convert.new("/dir/myfile.pdf").to :eps,  :multipage => true, :filename => "/tmp/test.eps", :range => 1..5
+# 
+# ====Getting files after convertion
+#  files=Convert.new("/dir/myfile.pdf").to :eps,  :multipage => true, :filename => "/tmp/test.eps", :range => 1..5
+#  files.class # => Array because parameter multipage is true
+#  
+#  file=Convert.new("/dir/myfile.pdf").to :eps, :filename => "/tmp/test.eps"
+#  file.class # => File 
+# 
+class RGhost::Convert 
   attr_reader :error, :errors
-  #Nova inst�ncia de Convert
-  # filename - Arquivo de entrada em pdf
+  
+  
   def initialize(filename)
     @filename=filename
     
     
   end
-  # Converte para o formato device usando as op��es do RubyGhostEngine.
-  # A op��o :range � v�lida para este m�todo
+
+  
   def to(device, options={})
-    rge=RubyGhostEngine.new(@filename,options)
+    rge=RGhost::Engine.new(@filename,{:convert=>true}.merge(options))
     
     
     out=rge.render(device)

data/lib/rghost/cursor.rb

@@ -1,92 +1,124 @@
 require "point"
 require 'ps_object'
 require 'point_with_command'
-#Controla o posicionamento dos elementos na p�gina
-class Cursor < PsObject
+#It resposible to cursor manipulate. Use it to position objects on the page.
+class RGhost::Cursor < RGhost::PsObject
 
-  #Vai para uma determinada faixa
-  # d=Document.new
-  # d.set Cursor.goto_row(15)
-  # d.set Show.new("Row 15")
-  def Cursor.goto_row(row)
-    g=PsObject.new(row.to_i)
+  #The class method goto positioned the cursor based on page row number. Example: 
+  #  d=Document.new
+  #  d.goto_row 15
+  #  d.show " You're on row 15"
+  #  d.goto_row 3
+  #  d.show "Now you're on row 3"
+  #  
+  #  #or without facade(**it's valid for all methods on this class**)
+  #  
+  #  d=Document.new
+  #  d.set Cursor.goto_row(15)
+  #  d.set Show.new(" You're on row 15")
+  #  d.set Cursor.goto_row(3)
+  #  d.set Show.new("Now you're on row 3")
+  def self.goto_row(row)
+    g=RGhost::PsObject.new(row.to_i)
     g.call :goto_row
     g.call :default_point
     g
   end
-  #Salta um n�mero de faixas
+  #Jump n rows relative to the current row
   # d=Document.new
-  # d.set Cursor.jump_row(4)    #salta 4 faixas para baixo
-  # d.set Cursor.jump_row(-5)   #volta 5 faixas para cima
-  def Cursor.jump_rows(row)
-    j=PsObject.new(row.to_i)
+  # d.jump_row 4    # jump four rows below
+  # d.jump_row -5   # backing five rows to up
+  def self.jump_rows(row)
+    j=RGhost::PsObject.new(row.to_i)
     j.call :jump_rows
     j.call :default_point
     j
   end 
-  #Rotaciona objetos. Recomendado a utiliza��o dentro de um Newpath
-  # 
+  #Rotate all objects after execution it, passing the angle as argument.
   # d=Document.new
-  # d.newpath do
-  #   set Cursor.rotate(90)
-  #   #fa�a algo em 90� e retorne o cursor
-  #   set Cursor.rotate(-90)   
-  # end
-  def Cursor.rotate(angle)
-    r=PsObject.new(angle.to_i)
+  # d.rotate 90
+  # #do something
+  # d.rotate -90  # backing to source angle 
+  def self.rotate(angle)
+    r=RGhost::PsObject.new(angle.to_i)
     r.call :rotate
     r 
   end
-  #Move o cursor para uma determinada posi��o
+  #Move cursor to absolute point relative from default source point x=0 and y=0 of the page. It no interferes to the rows positions.
   # doc=Document.new
-  # doc.set Cursor.moveto(:x=> 10, :y=> 5)
-  # doc.set Show.new("Hello Girls!!!")
-  def Cursor.moveto(point={})
-    PointWithCommand.to(:moveto,point)
+  # doc.moveto :x=> 10, :y=> 5
+  # doc.show "Hello Girls!!!"
+  def self.moveto(point={})
+    RGhost::PointWithCommand.to(:moveto,point)
   end
-  #Move o cursor para uma determinada posi��o relativa ao posi��o corrente
+  #It works the same way that moveto, the unique difference it's relative from current point.
   # doc=Document.new
-  # doc.set Cursor.moveto(:x=> 10, :y=> 5)
-  # doc.set Show.new("Hello Girls!!!")
-  # doc.set Cursor.rmoveto(:x => 5) #move para x=> 15 (10 mais 5) e mantem y => 5
-  def Cursor.rmoveto(point={})
-    PointWithCommand.to(:rmoveto,point)
+  # doc.moveto :x=> 10, :y=> 5
+  # doc.show "Hello Girls!!!"
+  # doc.rmoveto :x => 5  # move to x=> 15 (10 plus 5) maintaining y => 5
+  def self.rmoveto(point={})
+    RGhost::PointWithCommand.to(:rmoveto,point)
   end
-  #Desloca a refer�ncia padr�o(:x=> 0, :y => 0, esquerda inferior) da p�gina para uma nova
+  #It changes the default pont to a new point(dislocate)
   # doc=Document.new
-  # doc.set Cursor.translate(:x=> 2, :y=> 1)
-  # doc.set Cursor.moveto(:x => 0,:y => 0)  #Ponto :x=> 2, :y=> 1
-  # doc.set Cursor.translate(:x=> -2, :y=> -1)  #retorna ao ponto padr�o
-  def Cursor.translate(point={:x =>0 , :y => 0})
+  # doc.translate :x=> 2, :y=> 1
+  # doc.moveto :x => 0,:y => 0   # if it was default point(0,0) would be :x=> 2, :y=> 1
+  # doc.translate :x=> -2, :y=> -1  # return to default source point
+  def self.translate(point={:x =>0 , :y => 0})
     p={:x =>0 , :y => 0}.merge(point)
-    PointWithCommand.to(:translate,p)
+    RGhost::PointWithCommand.to(:translate,p)
   end
-  #Salta para a pr�xima faixa com controle de p�gina
-  def Cursor.next_row
-    PsObject.new(:nrdp)
-    #ps.call :next_row
-    #ps.call :default_point
-    #
-    
+  
+  #Jump one next row. It's same that jump_row(1). 
+  # doc=Document.new
+  # doc.show "Row 1"
+  # doc.next_row
+  # doc.show "Row 2"
+  # doc.next_row
+  # doc.show "Row 3"
+  def self.next_row
+    RGhost::PsObject.new(:nrdp)
   end
-  #Vai para a pr�xima p�gina com controle de cursores e p�ginas
+  #It go to next page resetting the cursors.
+  # doc=Document.new
+  # doc.show "Page 1 row 1"
+  # doc.next_page 
+  # doc.show "Page 2 row 1"
+  # doc.next_page
+  # doc.show "Page 3 row 1"
   def next_page
-    PsObject.new :next_page
+    RGhost::PsObject.new :next_page
   end
-  #Salta a p�gina sem controle de cursores
+  #It go to next page without resetting the cursors. Often used for single page document.
+  # doc=Document.new
+  # doc.show "Page 1 row 1"
+  # doc.showpage # page 2, but internally
+  # doc.show "Page 1 row 1"
+  # doc.showpage # page 3
+  # doc.show "Page 1 row 1"
   def showpage
-    PsObject.new :showpage
+    RGhost::PsObject.new :showpage
   end
- 
-  #Vai para a pr�xima p�gina com controle de cursores e p�ginas
-  def Cursor.next_page
-    PsObject.new :next_page
+  #(Class method) It go to next page resetting the cursors.
+  # doc=Document.new
+  # doc.show "Page 1 row 1"
+  # doc.next_page 
+  # doc.show "Page 2 row 1"
+  # doc.next_page 
+  # doc.show "Page 3 row 1"
+  def self.next_page
+    RGhost::PsObject.new :next_page
   end
-  #Salta a p�gina sem controle de cursores
-  def Cursor.showpage
-    PsObject.new :showpage
+  #(Class method) It go to next page without resetting the cursors. Often used for single page document.
+  # doc=Document.new
+  # doc.show "Page 1 row 1"
+  # doc.showpage # page 2, but internally
+  # doc.show "Page 1 row 1"
+  # doc.showpage # page 3
+  # doc.show "Page 1 row 1"
+  def self.showpage
+    RGhost::PsObject.new :showpage
   end
- 
   
 end
 

data/lib/rghost/dash.rb

@@ -0,0 +1,59 @@
+#Sets the dash pattern on border lines. It accepts an array of
+#non-negative numbers with atleast one non-zero. Samples:
+# [2,1]     #=> 2 turn on and 1 off, 2 turn on and 1 off ...
+# [3,1,2,5] #=> 3 on, 1 off, 2 on, 5 off ... repeating until end
+# 
+#
+#===Examples using dash as border parameter
+# d=Document.new
+# d.horizontal_line(:bottom, :border=>{:dash => 1, :width => 2 }) 
+#link:images/dash01.png
+# 
+# d=Document.new
+# d.horizontal_line(:bottom, :border=>{:dash => [1,1], :width => 2 })
+#link:images/dash01.png
+# 
+# d=Document.new
+# d.horizontal_line(:bottom, :border=>{:dash => [1,2,1], :width => 2 })
+#link:images/dash03.png
+# 
+# d=Document.new
+# d.horizontal_line(:bottom, :border=>{:dash => [2,10,5], :width => 2 })
+#link:images/dash04.png
+# 
+# d=Document.new
+# d.horizontal_line(:bottom, :border=>{:dash => [1,1,3,1,5,1,7,1,9,1,10], :width => 4 })
+#link:images/dash05.png
+#
+#===Examples using Dash class
+# d=Document.new
+# d.scale(1,8)
+# d.set Dash.new([1,1,2,1,2,1,3])
+# d.line_width 3
+# d.lineto :x => :limit_right, :y => :Y
+#link:images/dash06.png
+
+
+class RGhost::Dash < RGhost::PsObject
+  include RGhost::RubyToPs
+  DEFAULT_OPTIONS={
+    :style => [1,2,3],
+    :offset => 0
+    
+  }
+  
+  def initialize(options={})
+    super(""){}
+    if options.is_a?(Numeric) || options.is_a?(Array)
+      @options = DEFAULT_OPTIONS.dup.merge(:style => options)
+    else
+      @options = DEFAULT_OPTIONS.dup.merge(options)
+    end
+  end
+  
+  def ps
+    ary=to_array( [@options[:style]].flatten)
+    "#{ary}#{@options[:offset]} setdash"
+  end
+  
+end