rghost 0.7.4 → 0.8

data/lib/rghost/ruby_ghost_config.rb

@@ -1,28 +1,236 @@
 require "ps_object"
 require 'iconv'
+require 'font_map'  
 
-module RubyGhostConfig
-  GS={
-      :mode => :gsparams,
-      :path => "/usr/bin/gs",
-      :tmpdir => ENV["TMP"] || ENV["TMPDIR"] || ENV["TEMPDIR"] || ENV["TEMP"] || "/tmp",
-      :pslibdir => File.dirname(__FILE__)+File::SEPARATOR+"ps",
-      :default_params=> %w(gs -dNOPAUSE -dBATCH -dQUIET -dNOPAGEPROMPT),
-      :stack_elements => 5000,
-      :font_encoding => :IsoLatin,
-      :charset_convert => nil, #lambda {|text| Iconv::iconv('latin1','utf8', text) },
-      :fontsize => 8,
-      :unit => Units::Cm
-  }
+#Rghost setup with Ghostscript.
+#Ghostscript runs on a variety of platforms, this is why we recommend the non coupled install for non *nix environments. 
+#The gem already comes with a set of defaults but you can change the settings using the Hash RGhost::Config::GS before each use of the API. Listed below are the keys of the said hash.
+#===RGhost::Config::GS[:mode]
+#Operating mode
+#* <tt>:gsparams</tt> In this mode RGhost just pass parameters to the Ghostscript framework.
+#* <tt>:gsapi</tt> based on the exchange of data between Ruby and Ghostscript via rgengine.so using gslib.so.8 or gslib-esp.so.8. 
+#
+#===RGhost::Config::GS[:path]
+#Path to the ghostscript executable.
+#====Example on windows
+#RGhost::Config::GS[:path] = "C:\\gs\\bin\\gswin32c.exe"
+#====Example on Linux
+#RGhost::Config::GS[:path] = "/usr/bin/gs"
+#
+#===RGhost::Config::GS[:tmpdir]
+#Temporary directory
+#====Example
+#RGhost::Config::GS[:tmpdir] = "/tmp"
+#
+#===RGhost::Config::GS[:default_params]
+#Allows you to add/remove options. (use with caution!)
+#====Example
+#RGhost::Config::GS[:default_params] << "-dSAFER"
+#
+#===RGhost::Config::GS[:stack_elements]
+#Defines the maximum number of elements for each matrix inside postscript's internal stack, avoiding a stack overflow error..
+#====Example
+#RGhost::Config::GS[:stack_elements]=5000
+#
+#===RGhost::Config::GS[:unit]
+#Set the measure units. See Units::Unit for available units. 
+#====Example
+#RGhost::Config::GS[:unit]=Units::Cm
+#
+#===RGhost::Config::GS[:charset_convert]
+#Ruby to PS character conversion proxy.  Necessary when the source code isn't on the same encoding of the document.
+#Params is a block that returns a String. The default setting is nil.
+#====Example
+#RGhost::Config::GS[:charset_convert]= lambda {|text| Iconv::iconv("latin1","utf8", text).to_s}
+#
+#===RGhost::Config::GS[:font_encoding]
+#Sets the Postscript font encoding. Default: :IsoLatin
+#====Example
+#RGhost::Config::GS[:font_encoding]= :IsoLatin
+#
+module RGhost::Config
+  
+  DEFAULT_PORTRAIT_TEMPLATE  = File.join(File.dirname(__FILE__),"ps","rghost_default_template.eps")
   
   
+  GS={
+    :mode => :gsparams,
+    :plugin => nil,
+    :path => "/usr/bin/gs",
+    :tmpdir => ENV["TMP"] || ENV["TMPDIR"] || ENV["TEMPDIR"] || ENV["TEMP"] || "/tmp",
+    :pslibdir => File.join( File.dirname(__FILE__),"ps"),
+    :extensions => [],
+    :preload => [],
+    :default_params=> %w(gs -dNOPAUSE -dBATCH -dQUIET -dNOPAGEPROMPT),
+    :stack_elements => 5000,
+    :font_encoding => :IsoLatin,
+    :charset_convert => lambda {|text| Iconv::iconv('latin1','utf8', text) },
+    :fontsize => 8,
+    :unit => RGhost::Units::Cm
+  }
+ 
+ 
+    
+ 
   
-  def RubyGhostConfig.config_platform
+  def self.config_platform #:nodoc:
     
     GS[:path]=case PLATFORM
-      when /linux|darwin|freebsd/: "/usr/bin/gs"
-      when /mswin/: "C:\\gs\\bin\\gswin32\\gswin32c.exe"
+    when /linux|darwin|freebsd/: "/usr/bin/gs"
+    when /mswin/: "C:\\gs\\bin\\gswin32\\gswin32c.exe"
     end
   end
+  #Test if your environment is ready to works. If yes the page below will show.
+  #
+  #link:images/is_ok.png
+  #
+  #You can generate this page with the code.
+  # RGhost::Config.is_ok?.render :pdf, :filename => "/tmp/mytest.pdf"
+  #
+  def self.is_ok?
+    d=RGhost::Document.new  :margin_left => 2.3, :margin_bottom => 2.3
+    d.benchmark(:start)
+    d.before_page_create do
+      image RGhost::Config::DEFAULT_PORTRAIT_TEMPLATE
+    end
+    d.define_tags do
+      new :bigger,   :size => 150, :color => "#AAFF33"
+    end
+    d.text_in :x => 6, :y=> 15, :write => "Yes!", :with => :bigger
+    d.text_in :x => 10, :y=> 14, :write => "Your environment is ready!"
+    d.text_in :x => 10, :y=> 13, :write => "RGhost Version " + RGhost::VERSION::STRING
+    d.text_in :x => 10, :y=> 12, :write => "Created at " + Time.at(RGhost::VERSION::DATE).to_s
+    d.text_in :x => 10, :y=> 11, :write => "Now " + Time.now.to_s
+    
+    d.benchmark(:stop)
+    d.done
+    d
+    
+    
+    
+  end
+  #This method is a helper to gets the best encoding.
+  #
+  #link:images/encode_test.png
+  #
+  #You can generate this page with the code.
+  # RGhost::Config.encode_teste("Fiancé").render :pdf, :filename => "/tmp/mytest.pdf"
+  # 
+  #The encode will use on Document class.
+  # doc=Document.new :font_encoding => 'IsoLatin'
+  #
+  def self.encode_test(value)
+    d=RGhost::Document.new  :paper => :A4, :margin_left => 2 #, :landscape => true
+    d.before_page_create do
+      image RGhost::Config::DEFAULT_PORTRAIT_TEMPLATE
+    end
+    exp=File.join(File.dirname(__FILE__),"ps","*.enc")
+    d.show "String (Using Helvetica Font)", :with => :b
+    d.moveto :x => 16
+    d.show "Encode Name", :with => :b
+    d.horizontal_line :bottom
+    d.next_row
+    
+    Dir.glob(exp).sort.each do |f|
+      name=File.basename(f)
+      name.gsub!(/\.enc/,'')
+      d.set RGhost::Load.library(name,:enc)
+      d.set RGhost::Variable.new(:default_encoding,name)
+      d.set RGhost::FontMap.new {
+        new(:font_test,  :name => "Helvetica",:size => 8,:color => "#FF0000", :encoding => true)
+      }
+      
+      d.show "#{value}" , :with => :font_test
+      d.moveto :x => 16
+      d.show "#{name}", :with =>  :i
+      d.next_row
+      
+    end
+    d
+  end
+  #Generates font catalog to use into method define_tags on Document
+  #  RGhost::Config.enviroment_fonts.render :pdf, :filename => "mycatalog.pdf"
+  #link:images/environment_fonts.png
+  #
+  def self.environment_fonts(text="The quick brown fox jumps over the lazy dog")
+    
+    d=RGhost::Document.new  :margin_left => 2.3, :margin_bottom => 2.3
+    d.before_page_create do
+      image RGhost::Config::DEFAULT_PORTRAIT_TEMPLATE
+    end
+    d.show "Search Path"
+    d.horizontal_line :bottom
+    d.next_row
+    d.raw :default_font
+    d.raw %Q{
+    LIBPATH{
+      limit_left  current_row  moveto   show    
+      nrdp
+    } forall
+    
+    }
+    d.next_row
+    d.show "Example"
+    d.moveto :x=> 13
+    d.show "Font Name"
+    d.horizontal_line :bottom
+    d.next_row
+    #=begin    
+    d.raw %Q{
+      Fontmap{ 
+        50 string cvs pop dup findfont 10 scalefont setfont
+        limit_left  current_row  moveto  (#{text})  show    
+    13 cm  current_row moveto default_font  0 setgray
+    50 string cvs show
+    nrdp  
+      } forall
+    }
+    #=end    
+    d.done
+    d
+  end
 
+  # .
+  #
+  #
+  #Preseted tags   
+  #
+  #
+  #
+  #FONTMAP=RGhost::FontMap.new :name => "Helvetica", :size => 8, :encoding => false do
+  #    new :span
+  #    new :b,     :name => "Helvetica-Bold"
+  #    new :bold,     :name => "Helvetica-Bold"
+  #    new :normal,   :name => "Helvetica"
+  #    new :i,     :name => "Helvetica-Oblique", :size => 8
+  #    new :bi,    :name => "Helvetica-BoldOblique"
+  #    new :big,   :size => 10
+  #    new :small, :size => 7
+  #    new :h1,    :name => "Helvetica", :size => 14
+  #    new :h2,    :name => "Helvetica", :size => 13
+  #    new :h3,    :name => "Helvetica", :size => 12
+  #    new :h4,    :name => "Helvetica", :size => 11
+  #    new :h5,    :name => "Helvetica", :size => 10
+  #    new :title, :name => "Helvetica", :size => 20
+  #    new :pre,   :name => "Courier"
+  #  end
+  #
+  FONTMAP=RGhost::FontMap.new :name => "Helvetica", :size => 8, :encoding => false do
+    new :span
+    new :b,     :name => "Helvetica-Bold"
+    new :bold,     :name => "Helvetica-Bold"
+    new :normal,   :name => "Helvetica"
+    new :i,     :name => "Helvetica-Oblique", :size => 8
+    new :bi,    :name => "Helvetica-BoldOblique"
+    new :big,   :size => 10
+    new :small, :size => 7
+    new :h1,    :name => "Helvetica", :size => 14
+    new :h2,    :name => "Helvetica", :size => 13
+    new :h3,    :name => "Helvetica", :size => 12
+    new :h4,    :name => "Helvetica", :size => 11
+    new :h5,    :name => "Helvetica", :size => 10
+    new :title, :name => "Helvetica", :size => 20
+    new :pre,   :name => "Courier"
+  end
+  
 end

data/lib/rghost/ruby_ghost_engine.rb

@@ -1,21 +1,12 @@
 require 'ruby_ghost_config'
 require "constants"
-#Motor do RubyGhost. Trata parametros e arquivos tempor�rios para a compila��o do Postscript.
-#
-class RubyGhostEngine
+
+class RGhost::Engine
   attr_reader :errors, :error, :output
   DEFAULT_OPTIONS={:device => :pdf }
   
-  include Constants::Devices
-  #Nova inst�ncia de RubyGhostEngine
-  # d=Document.new
-  # rge=RubyGhostEngine.new(d, :logfile => "/var/log/rgengine.log")
-  # img=rge.render(:gif)
-  # if rge.error 
-  #   puts rge.errors
-  # else
-  #   FileUtils.cp(img,"/local/my/dir/")
-  # end
+  include RGhost::Constants::Devices
+
   def initialize(document,options={})
     @document=document   
     @options=DEFAULT_OPTIONS.merge(options)
@@ -26,44 +17,26 @@ class RubyGhostEngine
 
   end 
 
-  #Renderiza o documento.
-  #Valores v�lidos para options.
-  #   
-  #   :logfile => "/var/log/rghost.log"    
-  #   :multipage=> true     # Para imagens em v�rios arquivos
-  #   :resolution => 72     # Resolu��o
-  #   :size => "200x180"    # Para crop da imagem de sa�da
-  #   :range =>2..3         # Range de p�ginas(PDF only)
-  #Array contendo um Hash para op��es em modo raw do Ghostscript :d ou :s
-  #   :s => [{:GenericResourceDir, :DEFAULTPAPERSIZE=> "a3"}]
-  #   :d => [ {:TextAlphaBits => 2}  ]
-  #
-  #Exemplo:
-  #  d=Document.new
-  #  #fa�a o documento ....
-  #  
-  #  d.render :pdf           # Sa�da em pdf    
-  #  d.render :jpeg          # Sa�da em jpeg   
-  #  d.render :png, :multipage => true  # Uma imagem por arquivo
-  #  d.render :tiff, :resolution => 300  # Imagem com resolu��o de 300 dpi
+
   def render(device=nil)
-    #puts @options.inspect
+
     device||=@options[:device]
     tmp_filename=@options[:filename]
     unless tmp_filename
-      tmp_filename||="#{RubyGhostConfig::GS[:tmpdir]}#{File::SEPARATOR}#{self.object_id.abs}"
+      tmp_filename||="#{RGhost::Config::GS[:tmpdir]}#{File::SEPARATOR}#{self.object_id.abs}"
       file_out="#{tmp_filename}.#{device}"
     else
       file_out=tmp_filename
     end
-    #puts file_out
+
     file_err="#{tmp_filename}.rgerr"
 	  
     multipage=@options[:multipage] 
     file_out.gsub!(/\./,"_%04d.") if multipage
     
-    params=RubyGhostConfig::GS[:default_params].dup #default parameters gs engine
-    params << "-I#{RubyGhostConfig::GS[:pslibdir]}"
+    params=RGhost::Config::GS[:default_params].dup #default parameters gs engine
+    params << "-I#{RGhost::Config::GS[:pslibdir]}"
+    params << "-I#{RGhost::Config::GS[:extensions].join(' -I')}" if RGhost::Config::GS[:extensions]
     params << "-sDEVICE=#{device_for(device)}"
     params.concat format_params(@options[:d],"-d") if  @options[:d]
     params.concat format_params(@options[:s],"-s") if  @options[:s]     
@@ -79,31 +52,31 @@ class RubyGhostEngine
      
     
     case @document 
-    when Document:
-      file_in="#{tmp_filename}.rgin"
+    when RGhost::Document:
+        file_in="#{tmp_filename}.rgin"
       params.concat @document.gs_paper
       fi=File.open(file_in,'w')
       fi.puts @document.ps
       fi.close
     when File:
-      file_in=@document.path
-      @delete_input=false
+        file_in=@document.path
+      #@delete_input=false unless @options[:debug]
     when String:
-      file_in=@document
-      @delete_input=false
+        file_in=@document
+      #@delete_input=false unless @options[:debug]
     end
 
     params << file_in
     
     #puts params.inspect
     
-    if RubyGhostConfig::GS[:mode] == :gslib
+    if RGhost::Config::GS[:mode] == :gslib
       require "rgengine"
       gs=RGEngine.new 
       @error=!gs.render(params,params.size)
     else
       require 'gs_alone'
-      gs=GSAlone.new(params)
+      gs=RGhost::GSAlone.new(params,@options[:debug])
       @error=!gs.run
     end
     
@@ -117,9 +90,11 @@ class RubyGhostEngine
         @output=File.open(file_out)
       end
     end
-    File.delete(file_err)
-    File.delete(file_in) if @delete_input 
-		
+    begin
+      File.delete(file_err)
+      File.delete(file_in) unless (@options[:debug] || @options[:convert])
+    rescue
+    end 
     log(params) if @options[:logfile]
     return @output
   end
@@ -127,16 +102,18 @@ class RubyGhostEngine
   def clear_output
     case @output
     when File:
-      @output.close
+        @output.close
       File.delete(@output.path)
     when Array: 
-      @output.each do |f| 
+        @output.each do |f| 
         f.close
         File.delete(f.path)
       end
     end
   end
-
+  def error?
+    @error
+  end
   private
   def log(gp)
     id=self.object_id.abs
@@ -157,13 +134,13 @@ class RubyGhostEngine
     r=[]
     case v
     when Symbol:
-      r << "#{pre}#{v}"
+        r << "#{pre}#{v}"
     when Array:
-      v.each do |av|
+        v.each do |av|
         r << format_params(av,pre).to_s
       end
     when Hash:
-      v.each do |k,v|
+        v.each do |k,v|
         r << "#{pre}#{k}=#{v.to_s.gsub(/ /,'')}"  	
       end
     else

data/lib/rghost/ruby_ghost_version.rb

@@ -0,0 +1,8 @@
+module RGhost::VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 8
+    TINY  = 0
+    DATE=1211385093
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  
+end

data/lib/rghost/ruby_to_ps.rb

@@ -1,63 +1,62 @@
-#Modulo de convers�o e tratamento de valores de Ruby para Postscript
-module RubyToPs
+#Converts Ruby types to Postscript types
+module RGhost::RubyToPs
 
-  #Converte uma string Ruby para string Postscript
-	def to_string(value)
-		#ps escape
+  
+  def to_string(value)
+    #ps escape
     value=pack_string(value)
-		ps_str=ps_escape(value)
+    ps_str=ps_escape(value)
     
-		"(#{ps_str}) "
+    "(#{ps_str}) "
 
-	end
-	def pack_string(s)
-  	if RubyGhostConfig::GS[:charset_convert] 
-   	  RubyGhostConfig::GS[:charset_convert].call(s.to_s).to_s 
+  end
+  
+  def pack_string(s)
+    if RGhost::Config::GS[:charset_convert] 
+      RGhost::Config::GS[:charset_convert].call(s.to_s).to_s 
     else
       s
     end
-	end
+  end
 	
-	#Escapa ( e ) para string postscript
-	def ps_escape(value)
-	   value.to_s.gsub(/(\(|\))/,'\\\\\1')
-	end
-	#Converte para ps bool
-	def to_bool(value)
-     value ? "true":"false"
-	end
-  #Converte para um array de string ps
-	def to_string_array(arr)
+  
+  def ps_escape(value)
+    value.to_s.gsub(/(\(|\)|\\)/,'\\\\\1')
+  end
+  
+  def to_bool(value)
+    value ? "true":"false"
+  end
+  
+  def to_string_array(arr)
 		
-		"[#{arr.map{|a| to_string(a.to_s) }}] "
-	end
-	#Converte para um array ps
-	def to_array(arr)
-	 return "[ ]" unless arr
-	 ps_arr=[]
-		arr.each do |a|
-			ps_arr << case a
-				when TrueClass,FalseClass: to_bool(a)
-				when Numeric: a
-				when Proc: a.to_s
-				when Array: to_array(a)
-				else
-					to_string(a.to_s)
-			end
-		end
-		"[#{ps_arr.join(' ')}] "
-	end
-  #Converte um hash para string array  ps
-	def hash_to_array(hash)
-			to_string_array(hash.values)
-	end
-  #'aload' converte um array para dados em pilha 
+    "[#{arr.map{|a| to_string(a.to_s) }}] "
+  end
+  
+  def to_array(arr)
+    return "[ ]" unless arr
+    ps_arr=[]
+    arr.each do |a|
+      ps_arr << case a
+      when TrueClass,FalseClass: to_bool(a)
+      when Numeric: a
+      when Proc: a.to_s
+      when Array: to_array(a)
+      else
+        to_string(a.to_s)
+      end
+    end
+    "[#{ps_arr.join(' ')}] "
+  end
+  
+  def hash_to_array(hash)
+    to_string_array(hash.values)
+  end
+  
   def array_to_stack(arr)
     "#{arr.join(' ')} "
   end
-  #Eval para dados internos de postscript.
-  # s=string_eval("Page: %current_page% of %count_pages%")
-  #As vari�veis s�o delimitadas por % 
+  
   def string_eval(str)
     str=pack_string(str)
     return "(#{ps_escape(str)}) show " unless str =~ /%/
@@ -67,37 +66,12 @@ module RubyToPs
     tudo=""
     s.each do |v|
       case v
-        when /^%/: tudo << "#{v.gsub(/%/,'')} to_s show "
-        else
-          tudo << "(#{ps_escape(v)}) show "
-       end
+      when /^%/: tudo << "#{v.gsub(/%/,'')} to_s show "
+      else
+        tudo << "(#{ps_escape(v)}) show "
+      end
     end
-     tudo
+    tudo
   end
 end
 
-
-
-#class Teste 
-#	include RubyToPs
-
-#end
-#Teste.new.string_eval("diga %current_row oi")
-
-#
-#class Ligacoes < ActiveRecord::Base
-#
-#end
-#
-#ActiveRecord::Base.establish_connection(:adapter => "postgresql",:database => "fonip", :host => 'solaris', :username => 'fonip', :password=>'qwe123')
-#
-#t=Teste.new
-#liga=Ligacoes.find(:all, :limit => 50, :conditions => "id > 100")
-#
-#puts liga.class
-#
-#liga.each do |l|
-#
-#puts t.hash_to_array(l.attributes)
-#
-#end

data/lib/rghost/scale.rb

@@ -1,14 +1,29 @@
 require "ps_object"
-#Escala dos objetos
+#Scales objects
 
-class Scale < PsObject
-  #Nova inst�ncia de Scale
-  # Scale.new(1,1)      # default postscript
-  # Scale.new(0.5,0.5)  # zoom de 50%
-  # Scale.new(2,2)      # zoom de 200%
+class RGhost::Scale < RGhost::PsObject
+  #===Examples
+  # doc.scale(1,1)      #default document scale
+  #
+  #link:images/scale01.png
+  #
+  # doc.scale(1,3)
+  #
+  #link:images/scale02.png
+  #
+  # doc.scale(3,3)
+  #
+  #link:images/scale03.png
   def initialize(sx,sy)
     super("#{sx} #{sy} scale")
   end
-
+  #Scale proportionally by value in percent
+  #===Example
+  # doc.zoom(300)   # 300% the same that scale(3,3)
+  def self.zoom(value=100)
+    
+    RGhost::Scale.new(value/100.0,value/100.0)
+  
+  end
 
 end

data/lib/rghost/shape_content.rb

@@ -0,0 +1,23 @@
+#Responsible for fill shapes
+class RGhost::ShapeContent < RGhost::PsObject
+
+  DEFAULT_OPTIONS={
+    :fill => true, :color => "#F0FFFF"
+    
+  }
+  #You can use parameter :color(facade for Color.create) or disable using :fill => false
+  def initialize(options={})
+    super(""){}
+    @options = DEFAULT_OPTIONS.dup.merge(options)
+  end
+  
+  def ps
+    p=RGhost::PsObject.new
+    p.raw :gsave
+    p.set RGhost::Color.create(@options[:color])  if @options[:color]
+    p.raw :fill if @options[:fill]
+    p.raw :grestore
+    p
+  end
+  
+end