lunks_rghost 0.8.7.6

data/lib/rghost/ruby_ghost_config.rb

@@ -0,0 +1,252 @@
+require "rghost/ps_object"
+require 'rghost/font_map'
+
+#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
+#
+#===RGhost::Config::GS[:external_encoding]
+#Sets the file-in external encoding (Ruby 1.9). Affects how data will be written and
+#could help when dealing with encoding conversion errors. Default: nil
+#====Example
+#RGhost::Config::GS[:external_encoding]= 'ascii-8bit'
+#
+module RGhost::Config
+
+  DEFAULT_PORTRAIT_TEMPLATE  = File.join(File.dirname(__FILE__),"ps","rghost_default_template.eps")
+
+
+  GS={
+    :mode => :gsparams,
+    :plugin => nil,
+    :path => nil,
+    :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 => begin
+      if RUBY_VERSION =~ /^1.9/
+        lambda { |text| text.encode('ISO-8859-1', 'UTF-8') }
+      else
+        require 'iconv'
+        lambda { |text| Iconv::iconv('latin1','utf-8', text).join }
+      end
+    end,
+    :external_encoding => nil,
+    :fontsize => 8,
+    :unit => RGhost::Units::Cm
+  }
+
+  def self.config_platform #:nodoc:
+    const= 'PLATFORM'
+    const = "RUBY_"+const if RUBY_VERSION =~ /^1.9/
+    GS[:path]=case Object.const_get(const)
+    when /linux/ then "/usr/bin/gs"
+    when /darwin/ then "/opt/local/bin/gs"
+    when /freebsd|bsd/ then "/usr/local/bin/gs"
+    when /mswin/ then "C:\\gs\\bin\\gswin32\\gswin32c.exe"
+    end
+    not_found_msg="\nGhostscript not found in your environment.\nInstall it and set the variable RGhost::Config::GS[:path] with the executable.\nExample: RGhost::Config::GS[:path]='/path/to/my/gs' #unix-style\n RGhost::Config::GS[:path]=\"C:\\\\gs\\\\bin\\\\gswin32c.exe\"  #windows-style\n"
+    raise not_found_msg unless (File.exists? GS[:path])
+  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 |b|
+      b.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 |b|
+      b.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 |b|
+      b.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 => true 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

@@ -0,0 +1,174 @@
+require 'rghost/ruby_ghost_config'
+require "rghost/constants"
+
+class RGhost::Engine
+  attr_reader :errors, :error, :output
+  DEFAULT_OPTIONS={:device => :pdf }
+
+  include RGhost::Constants::Devices
+
+  def initialize(document,options={})
+    @document=document
+    @options=DEFAULT_OPTIONS.merge(options)
+    @errors=[]
+    @error=false
+    @output=nil
+    @delete_input=true
+
+  end
+
+
+  def render(device=nil)
+
+    device||=@options[:device]
+    tmp_filename=@options[:filename]
+    unless tmp_filename
+      tmp_filename||="#{RGhost::Config::GS[:tmpdir]}#{File::SEPARATOR}#{self.object_id.abs}"
+      file_out="#{tmp_filename}.#{device}"
+    else
+      file_out=tmp_filename
+    end
+    external_encoding = RGhost::Config::GS[:external_encoding]
+
+    file_err="#{tmp_filename}.rgerr"
+
+    multipage=@options[:multipage]
+    file_out.gsub!(/^(.*)\./,'\1_%04d.') if multipage
+
+    params=RGhost::Config::GS[:default_params].dup #default parameters gs engine
+    params << @document.additional_params.join(" ") unless @options[:convert]
+    params << "-I#{RGhost::Config::GS[:pslibdir]}"
+    params << "-dPDFSETTINGS=/#{@options[:quality]}" if (@options[:device] ==:pdf && @options[:quality])
+    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]
+    params << "-r#{@options[:resolution]}" if @options[:resolution]
+    params << "-g#{@options[:size]}" if @options[:size]
+    if @options[:range]
+      params << "-dFirstPage=#{@options[:range].first}"
+      params << "-dLastPage=#{@options[:range].last}"
+    end
+    params << "-sstdout=#{file_err}"
+    params << @options[:raw] if @options[:raw]
+    params << "-sOutputFile=#{file_out}"
+
+
+    case @document
+    when RGhost::Document
+      file_in="#{tmp_filename}.rgin"
+      params.concat @document.gs_paper
+      mode=external_encoding.nil? ? 'w' : "w:#{external_encoding}"
+      fi=File.open(file_in,mode)
+      fi.puts @document.ps
+      fi.close
+    when File
+      file_in=@document.path
+      #@delete_input=false unless @options[:debug]
+    when String
+      file_in=@document
+      #@delete_input=false unless @options[:debug]
+    end
+
+    params << shellescape(file_in)
+
+    #puts params.inspect
+
+    if RGhost::Config::GS[:mode] == :gslib
+      require "rghost/rgengine"
+      gs=RGEngine.new
+      @error=!gs.render(params,params.size)
+    else
+      require 'rghost/gs_alone'
+      gs=RGhost::GSAlone.new(params,@options[:debug])
+      @error=!gs.run
+    end
+
+    if @error # if error
+      @errors=File.open(file_err).readlines if File.exists?(file_err)
+    else
+      if multipage
+      	file_out.gsub!(/_%04d/,"_*")
+        @output=Dir.glob(file_out).map { |f| f }
+      else
+        @output=File.open(file_out)
+      end
+    end
+    begin
+      File.delete(file_err)
+      File.delete(file_in) unless (@options[:debug] || @options[:convert])
+    rescue
+    end
+    log(params) if @options[:logfile]
+    return @output
+  end
+
+  def clear_output
+    case @output
+    when File
+        @output.close
+      File.delete(@output.path)
+    when Array
+        @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
+    flog=File.open(@options[:logfile], File::WRONLY|File::APPEND|File::CREAT)
+    flog.puts "[ID #{id}] created on #{Time.now}"
+    flog.puts "[#{id}] RUBY GS OPTIONS: #{@options.inspect}"
+    flog.puts "[#{id}] GS OPTIONS: #{gp.join(" ")}"
+    if @error
+      flog.puts "[#{id}] EXIT STATUS: ERROR"
+      flog.puts @errors.uniq.map {|m| "[#{id}] #{m}" }.to_s;
+    else
+      flog.puts "[#{id}] EXIT STATUS: OK"
+    end
+  end
+
+
+  def format_params(v,pre="-d")
+    r=[]
+    case v
+    when Symbol
+        r << "#{pre}#{v}"
+    when Array
+        v.each do |av|
+        r << format_params(av,pre).to_s
+      end
+    when Hash
+        v.each do |k,v|
+        r << "#{pre}#{k}=#{v.to_s.gsub(/ /,'')}"
+      end
+    else
+      return ""
+    end
+    return r;
+  end
+
+  def shellescape(str)
+    # An empty argument will be skipped, so return empty quotes.
+    return "''" if str.empty?
+
+    str = str.dup
+
+    # Process as a single byte sequence because not all shell
+    # implementations are multibyte aware.
+    str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/n, "\\\\\\1")
+
+    # A LF cannot be escaped with a backslash because a backslash + LF
+    # combo is regarded as line continuation and simply ignored.
+    str.gsub!(/\n/, "'\n'")
+
+    return str
+  end
+
+end
+

data/lib/rghost/ruby_ghost_version.rb

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

data/lib/rghost/ruby_to_ps.rb

@@ -0,0 +1,78 @@
+#Converts Ruby types to Postscript types
+module RGhost::RubyToPs
+
+  
+  def to_string(value)
+    #ps escape
+    value=pack_string(value)
+    ps_str=ps_escape(value)
+    
+    "(#{ps_str}) "
+
+  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
+	
+  
+  def ps_escape(value)
+    #value.to_s.gsub(/\(/,'\\(').gsub(/\)/,"\\)").gsub(/\\/,"\134")
+    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
+  
+  def to_array(arr)
+    return "[ ]" unless arr
+    ps_arr=[]
+    arr.each do |a|
+      ps_arr << case a
+      when TrueClass,FalseClass then to_bool(a)
+      when Numeric then a
+      when Proc then a.to_s
+      when Array then 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
+  
+  def string_eval(str)
+    str=pack_string(str)
+    return "(#{ps_escape(str)}) show " unless str =~ /%/
+
+    s=str.scan(/([^%][a-z]*[^%]|\d+%?)|(%[^\s%]+%)/).flatten.compact
+    #puts s 
+    tudo=""
+    s.each do |v|
+      case v
+      when /^%/ then tudo << "#{v.gsub(/%/,'')} to_s show "
+      else
+        tudo << "(#{ps_escape(v)}) show "
+      end
+    end
+    tudo
+  end
+end
+

data/lib/rghost/scale.rb

@@ -0,0 +1,29 @@
+require "rghost/ps_object"
+#Scales objects
+
+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

data/lib/rghost/show.rb

@@ -0,0 +1,88 @@
+require "rghost/ps_object"
+require "rghost/ruby_to_ps"  #to_string
+
+#Writes a text on the current row or point with align.
+class RGhost::Show < RGhost::PsObject
+  
+  attr_accessor :text, :align, :tag
+  DEFAULT_OPTIONS={:tag => :default_font, :align => :show_left}
+  include RGhost::RubyToPs
+  #===Options
+  #
+  #* <tt>:tag or :with</tt> - Use predefined tag
+  #* <tt>:color</tt> - Override color of the tag
+  #* <tt>:align</tt> - Align of the text
+  #===Examples
+  #The vertical line is the current point. For align by point
+  # doc.moveto :x => 3, :y => 4
+  # doc.show "Foo Bar Baz", :align => :show_left      #default
+  #link:images/show01.png 
+  #
+  # doc.moveto :x => 3, :y => 4
+  # doc.show "Foo Bar Baz", :align => :show_center 
+  #link:images/show02.png 
+  #
+  # doc.moveto :x => 3, :y => 4
+  # doc.show "Foo Bar Baz", :align => :show_right
+  #link:images/show03.png 
+  #
+  #For the the current row it's not necessary positioned using moveto. Like below
+  # doc.show "Foo Bar Baz", :align => :show_right
+  #Now justification in page
+  #
+  # doc.show "Foo Bar Baz", :align => :page_left     
+  # 
+  #link:images/show04.png 
+  #
+  # doc.show "Foo Bar Baz", :align => :page_center 
+  # 
+  #link:images/show05.png 
+  #
+  # doc.show "Foo Bar Baz", :align => :page_right
+  # 
+  #link:images/show06.png 
+  #
+  #====Overrinding tag's color 
+  #
+  # doc.show "Foo Bar Baz", :with => :my_italic, :align => :page_center, :color => :red 
+  # 
+  #link:images/show07.png 
+  #
+  #Many tags per row
+  #  doc=Document.new
+  #  doc.define_tags do
+  #    tag :font1, :name => 'Helvetica', :size => 10, :color => '#F34811' 
+  #    tag :font2, :name => 'Times',     :size => 14, :color => '#A4297A' 
+  #    tag :font3, :name => 'TimesBold', :size => 18, :color => '#AA3903' 
+  #  end
+  #
+  #  doc.show "foo bar baz ",  :with => :font1
+  #  doc.show "qux quux ",     :with => :font2
+  #  doc.show "corge ",        :with => :font3
+  #  doc.show "grault garply ",:with => :font2
+  #  doc.show "qux quux",      :with => :font1
+  #
+  #link:images/show08.png 
+  
+
+  
+  def initialize(text,options={ :align=>:show_left, :tag => :default_font, :color => 0 } )
+    @text = text
+    @options=DEFAULT_OPTIONS.dup.merge(options)
+  end
+  
+  def ps
+    rtext=RGhost::PsObject.new
+    #rtext.raw Color.create(@options[:color] || 0) 
+    if @options[:with] || @options[:tag]
+      f="_#{@options[:with] || @options[:tag]}"
+      rtext.raw f 
+    end
+    rtext.raw RGhost::Color.create(@options[:color])  if @options[:color]
+    rtext.raw to_string(@text)
+    rtext.raw @options[:align]
+    
+    rtext.graphic_scope
+  end
+
+end

data/lib/rghost/static_document_callback.rb

@@ -0,0 +1,18 @@
+require "rghost/ps_object"
+require 'rghost/function'
+
+class RGhost::StaticDocumentCallback < RGhost::Function #:nodoc:
+  ACCEPT=[:before_document_create,
+          :first_page,
+          :last_page,
+          :after_document_create 
+  ]  
+  
+  def initialize(name,&block)
+    raise NameError.new("#{name} no accept in #{self.class}") unless ACCEPT.include? name
+    super(name,&block)
+  end
+    
+
+end
+