rghost 0.7.4 → 0.8

data/lib/rghost/border.rb

@@ -0,0 +1,44 @@
+#Border object render a border around of vector shapes. Its sketch can be a combination of color, dashes, line joins and line caps.
+#Usually its use inside of object facades, such as, Document, CallbackFacade and PsFacade as parameter :border, for example:
+#  d=Document.new
+#  d.horizontal_line :middle, :border => { :color => '#058412', :dash => [1,0,2] }
+#You can use it as a new instance of Border and set inside of Document by method set, example:
+#  d=Document.new
+#  b=Border.new :color => '#058412', :dash => [1,0,2]
+#  d.set b
+#  d.lineto :x => 2.5, :y => 5
+#===Options
+#* <tt>:color</tt> - Facade to Color using the same parameter.
+#* <tt>:dash</tt> - Facade to Dash using the same parameter.
+#* <tt>:width</tt> - Facade to LineWidth using the same parameter.
+#* <tt>:linejoin</tt> - Sets the line join parameter in the graphics state to int, which must be one of the integers 0, 1, or 2. 
+#====:linejoin examples
+#* <tt>Miter join</tt> link:images/linejoin0.png <tt> :linejoin => 0 </tt>
+#* <tt>Round join</tt> link:images/linejoin1.png <tt> :linejoin => 1 </tt>
+#* <tt>Bevel join</tt> link:images/linejoin2.png <tt> :linejoin => 2 </tt>
+#* <tt>:linecap</tt> - Sets the line cap parameter in the graphics state to int, which must be one of the integers 0, 1, or 2
+#====:linecap examples
+#* <tt><tt>Butt cap</tt></tt> link:images/linecap0.png <tt> :linecap => 0 </tt>
+#* <tt>Round cap</tt> link:images/linecap1.png <tt> :linecap => 1 </tt>
+#* <tt>Projecting square cap</tt> link:images/linecap2.png <tt> :linecap => 2 </tt>
+class RGhost::Border < RGhost::PsObject
+
+  DEFAULT_OPTIONS = {:color => '#49AAFA', :dash => false, :width => 0.5, :linejoin => 0, :linecap => 0  }
+  # aqui tem documentação 
+  def initialize(options={})
+    super(""){}
+    @options = DEFAULT_OPTIONS.dup.merge(options)
+  end
+
+  def ps #:nodoc:
+    p=RGhost::PsObject.new
+    p.set RGhost::LineWidth.new(@options[:width]) if @options[:width]
+    p.raw "#{@options[:linejoin]} setlinejoin"
+    p.raw "#{@options[:linecap]} setlinecap"
+    p.set RGhost::Dash.new(@options[:dash])       if @options[:dash]
+    p.set RGhost::Color.create(@options[:color])  if @options[:color]
+    p
+  end
+ 
+end
+

data/lib/rghost/callback.rb

@@ -1,27 +1,33 @@
 require "ps_object"
 require "ruby_to_ps"
 
-# Callback representa uma chamada com condi��o :only e :except para elementos inteiros.
-# � gerado metac�digo em Postscript tendo como base um dict no formato abaixo.
-#   /dictname 3 dict def
-#	    dictname begin
-# 		  /proc {} bind def
-# 		  /except [ ] def
-# 		  /only [ ] def
-#     end
-# Obs: Se detectado pelo menos uma entrada para :only o :except n�o ser� executado
+# Callbacks are custom code blocks defined inside of Document. 
+# All callbacks received implicitly a instance of PsFacade can be creates any PsObject.
+# The callbacks's execution depend of the algorithims predefined in Postscript core library.
+# There are two kind of callbacks, Statics and Dynamics callbacks.
+# A Static callback there aren't parameters to control of the inclusion and exception on current scope, usually
+# applied for events which happen one time, for example after_document_create, "after document create" always will execute one time for each document.
+# Otherwise Dynamic callbacks there is control of scope using conditional :only or :except, this is only difference in relation the static callbacks.
+# The parameters of a Dynamic callbak must be one integer or one array of integer. Example:
+# For all pages except page 3
+#  doc.before_page_create :except => 3 do
+#      # do something
+#  end
 # 
-class Callback < PsObject
+# For just 2 and 4 pages
+#  doc.before_page_create :only => [2,4] do
+#      # do something
+#  end
+# 
+# The most of callbacks are defined in facades such as DocumentCallbackFacade and Grid::CallbackFacade
+class RGhost::Callback < RGhost::PsObject
   attr_accessor :only, :except, :name
-  include RubyToPs
-  #Nova inst�ncia de Callback
-  #  Responde as op��es
-  #   :only => [1,2]      # Array - Callback ser� executado somente para os valores
-  #   :except =>  [3,4]   # Array - Callback n�o executar� para os valores
-  #Exemplo:
-  #  Callback.new :only => [4,10,11]
-  def initialize(name,options={},&block) #((|name|))  nome do callback
-    super(&block)
+  include RGhost::RubyToPs
+
+  def initialize(name,options={},&block)
+    
+    super(""){}
+    set RGhost::PsFacade.new(&block)
     @name=name
     @options=options
     
@@ -29,11 +35,8 @@ class Callback < PsObject
   
   def ps
     
-    
     @only=num_to_array(@options[:only]) 
     @except=num_to_array(@options[:except])
-    
-  
   
     "\n/#{@name} 3 dict def #{@name} begin \n/proc { #{super} } bind def \n/except #{to_array(@except)} def \n/only #{to_array(@only)} def \nend "
     

data/lib/rghost/circle.rb

@@ -0,0 +1,102 @@
+require "ps_object"
+require "units"
+#Draw a circle to the current path(or current row by default).
+#===Options
+#
+#* <tt>:x and :y</tt> - as center of the circle.
+#* <tt>:radius</tt> - as radius(in points).
+#* <tt>:ang1</tt> - the angle of a vector from (:x , :y ) of length :radius to the first endpoint of the circle.
+#* <tt>:ang2</tt> - the angle of a vector from (:x, :y) of length :radius to the second endpoint of the circle.
+#* <tt>:content</tt> - facade to ShapeContent with same parameters.
+#* <tt>:border</tt> - facade to Border with same parameters.
+#* <tt>:use</tt> - <b>:arc</b> draw counterclockwise and <b>:arcn</b> (arc negative) clockwise direction. 
+#===Examples using facade circle method inside of Document
+#  d=Document.new
+#  d.circle :x => 5, :y => 2.5 , :radius => 40
+#
+#link:images/circle01.png
+#  d=Document.new
+#  d.circle :x => 5, :y => 2.5 , :radius => 40, :content => {:fill => false}
+#
+#link:images/circle02.png
+# 
+#  d=Document.new
+#  d.circle :x => 5, :y => 2.5 , :radius => 40, :content => {:color => "#FF0000"} 
+#
+#link:images/circle03.png
+# 
+#  d=Document.new
+#  d.circle :x => 5, :y => 2.5 , :radius => 40, :content => {:color => "#FF0000"} ,:border => {:color => "#FFFFFF"}
+#
+#link:images/circle04.png
+#  
+#  d=Document.new
+#  d.circle :x => 5, :y => 2.5 , :radius => 40, :content => {:color => :yellow} ,:border => {:color => :orange, :dash => [1,2,1,2], :width => 20}
+#
+#link:images/circle05.png
+# 
+#   d=Document.new
+#   colors=%w[#98AE09 #AFE099 #A971FF #CC1010 #FF7201 #34FEE1]
+#   6.downto(1) do |v|
+#     d.circle :x => 5, :y => 2.5 , :radius => v*10, :content =>{:color => colors[v]}
+#   end
+#   
+#link:images/circle06.png
+# d=Document.new
+# d.circle :x => 5, :y => 2.5 , :ang1 => 90, :radius => 50, :content => {:fill => false }   
+#    
+#link:images/circle07.png
+# 
+# d=Document.new
+# d.circle :x => 5, :y => 2.5 , :ang2 => 90, :radius => 50, :content => {:fill => false }   
+#    
+#link:images/circle08.png
+# 
+# d=Document.new
+# d.circle :x => 5, :y => 2.5 , :ang2 => 90, :radius => 50, :content =>{:color => :green}
+#    
+#link:images/circle09.png
+#
+# d=Document.new
+# d.circle :x => 5, :y => 2.5 , :ang2 => 90, :use => :arcn, :radius => 50, :content =>{:color => :green}
+#    
+#link:images/circle10.png
+#
+#===Examples using Circle class
+#   d=Document.new 
+#   d.scale(3,1)
+#   d.set Circle.new(:x => 1.5, :y => 1.5 , :ang2 => 180, :radius => 25)
+#
+#link:images/circle11.png
+class RGhost::Circle < RGhost::PsObject
+  DEFAULT_OPTIONS={
+    :x => :limit_left,
+    :y=> :current_row,
+    :radius => 50, 
+    :ang1 => 0, 
+    :ang2 => 360 , 
+    :use => :arc, 
+    :content => RGhost::ShapeContent::DEFAULT_OPTIONS,
+    :border =>  RGhost::Border::DEFAULT_OPTIONS
+    }
+  
+  def initialize(options={})
+    super(''){}
+      @options=DEFAULT_OPTIONS.dup.merge(options)
+  end
+ 
+  def ps
+    
+    x,y= RGhost::Units::parse(@options[:x]), RGhost::Units::parse(@options[:y]) #with parse
+    
+    graph=RGhost::Graphic.new
+    graph.raw :newpath
+    graph.set RGhost::Border.new(@options[:border]) if @options[:border]
+    graph.raw  "#{x} #{y} #{@options[:radius]} #{@options[:ang1]} #{@options[:ang2]} #{@options[:use]} " 
+    graph.set RGhost::ShapeContent.new(@options[:content]) if @options[:content]
+    graph.raw :stroke
+    graph
+
+  end
+
+end

data/lib/rghost/color.rb

@@ -2,38 +2,53 @@ require "ps_object"
 require "constants"
 require "ruby_to_ps" #array_to_stack
 
-#Prototype de Colores
-#Os valores no intevalo de 0.0 a 1.0 se o valor for maior que 1 ser� dividido por 100.
-class Color < PsObject
+#Creates color for postscript components
+class RGhost::Color < RGhost::PsObject
   
-  include RubyToPs
-  #Cria uma cor RGB ou CMYK ou Gray dependendo do tipo do valor de entrada(factory).
-  # Para o tipo 
-  #   String  => RGB valor em Hexa  color='#FFAA33'
-  #   Array   => CMYK com 4 elementos color=[0.5, 0, 0, 1] 
-  #   Array   => RGB com 3 elementos  color=[0.5, 0, 0]
-  #   Hash    => CMYK - color={:cyan=> 1 ,:magenta => 0, :yellow => 0, :black => 0}
-  #   Hash    => RGB  - color={:red => 0, :green => 0, :blue => 0}
-  #   Numeric => Gray - color=0.5
-  #Exemplos:
-  # Color.create("#03D5F2") #RGB
-  # Color.create([0.3, 0.4, 0.2, 0.9]) #CMYK
-  # Color.create(0.9) #Gray
-  def Color.create(color='#000000')
+  include RGhost::RubyToPs
+  #The method create is a color factory depends when parameter is used. The parameter variate between 0 and 1, if value greatet that 1 will be divided by 100.0 .
+  #===Examples
+  #====Creating RGB color
+  #String HTML color converter
+  # Color.create '#FFAA33'
+  #As Symbol will be find in RGhost::Constants::Colors::RGB
+  # Color.create :red         
+  #As Array with 3 elements 
+  # Color.create [0.5, 0.3, 0.5]
+  #Hash with 3 pair of key/value. Valids keys :red, :green and :blue
+  # Color.create :red => 0.5, :green => 0.3, :blue => 0.5 
+  #Hash with 3 pair of key/value. Valids keys :r, :g and :b
+  # Color.create :r => 0.5, :g => 0.3, :b => 0.5
+  #====Creating CMYK color
+  #Hash with 4 pair of key/value. Valids keys :cyan, :magenta, :yellow and :black
+  #  Color.create :cyan=> 1 ,:magenta => 0.3, :yellow => 0, :black => 0 
+  #Hash with 4 pair of key/value. Valids keys :c, :m, :y and :b
+  #  Color.create :c=> 1 ,:m => 0.3, :y => 0, :b => 0
+  #====Creating Gray color
+  #A single Numeric
+  # Color.create 0.5
+  #50 percent of black will be divided by 100.0
+  # Color.create 50
+  def self.create(color="FFAA99")
     
     return case color
-      when String: RGB.new(color)
-      when Array, Hash:
+    when String: RGhost::RGB.new(color)
+    when Symbol:
+        c=RGhost::Constants::Colors::RGB[color]
+      raise ArgumentError.new("#{color}##{color.class}") unless c 
+      self.create c
+         
+    when Array, Hash:
         if color.size == 3
-          RGB.new(color)
-        elsif color.size == 4 
-          CMYK.new(color)
-        else
-          raise ArgumentError.new
-        end
-      when Numeric: Gray.new(color)
+        RGhost::RGB.new(color)
+      elsif color.size == 4 
+        RGhost::CMYK.new(color)
       else
-        raise ArgumentError.new
+        raise ArgumentError.new("#{color}##{color.class}")
+      end
+    when Numeric: RGhost::Gray.new(color)
+    else
+      raise ArgumentError.new("#{color}##{color.class}")
     end
   
   end
@@ -41,18 +56,21 @@ class Color < PsObject
   
 end
 
-#Espa�o de cor RGB
-class RGB < Color
+#Creates RGB color
+class RGhost::RGB < RGhost::Color
   attr_accessor :red, :green, :blue
-  CONSTANTS=Constants::Colors::RGB
+  CONSTANTS=RGhost::Constants::Colors::RGB
   DEFAULT_RGB={:red => 0, :green => 0, :blue => 0}
-  #Nova inst�ncia de RGB
-  #Por sequ�ncia de parametros
-  #   RGB.new(0.5,1,0)
-  #   #ou Hash
-  #   RGB.new(:red => 0.5, :green => 1, :blue => 0)
-  #   #ou String
-  #   RGB.new('#F0FF00')   
+  #String HTML color converter
+  # Color.create '#FFAA33'
+  #As Symbol will be find in RGhost::Constants::Colors::RGB
+  # Color.create :red         
+  #As Array with 3 elements 
+  # Color.create [0.5, 0.3, 0.5]
+  #Hash with 3 pair of key/value. Valids keys :red, :green and :blue
+  # Color.create :red => 0.5, :green => 0.3, :blue => 0.5 
+  #Hash with 3 pair of key/value. Valids keys :r, :g and :b
+  # Color.create :r => 0.5, :g => 0.3, :b => 0.5
   def initialize(color_or_red=nil,green=nil,blue=nil)
     @color=color_or_red
     @color=[color_or_red.to_f,green.to_f,blue.to_f] if color_or_red.is_a? Numeric
@@ -63,11 +81,12 @@ class RGB < Color
   def ps
     
     value=case @color
-      when Hash:  [@color[:red],@color[:green],@color[:blue]]
-      when Array:  @color
-      when String: hex_to_rgb(@color) 
-      when NilClass: [0,0,1]
+    when Hash:  [@color[:red] || @color[:r],@color[:green] || @color[:g],@color[:blue] || @color[:b]]
+    when Array:  @color
+    when String: hex_to_rgb(@color) 
+    when NilClass: [0,0,1]
     end
+    
     array_to_stack(value.map{|n| n > 1 ? n/100.0: n})+"setrgbcolor"
   end
 
@@ -80,12 +99,15 @@ class RGB < Color
 
 end
 
-#Espa�o de cor CMYK
-class CMYK < Color
-   attr_accessor :cyan ,:magenta, :yellow, :black
-  CONSTANTS=Constants::Colors::CMYK
-  #Nova inst�ncia de CMYK
-  #   CMYK.new(:cyan=> 1 ,:magenta => 0, :yellow => 0, :black => 0)
+#Creates CMYK color space
+class RGhost::CMYK < RGhost::Color
+  attr_accessor :cyan ,:magenta, :yellow, :black
+  CONSTANTS=RGhost::Constants::Colors::CMYK
+  
+  #Hash with 4 pair of key/value. Valids keys :cyan, :magenta, :yellow and :black
+  #  Color.create :cyan=> 1 ,:magenta => 0.3, :yellow => 0, :black => 0 
+  #Hash with 4 pair of key/value. Valids keys :c, :m, :y and :b
+  #  Color.create :c=> 1 ,:m => 0.3, :y => 0, :b => 0
   def initialize(color={:cyan=> 1 ,:magenta => 0, :yellow => 0, :black => 0})
     @color=color
   end
@@ -93,25 +115,28 @@ class CMYK < Color
   def ps
 
     value=case @color
-      when Hash:  [@color[:cyan],@color[:magenta],@color[:yellow],@color[:black]]
-      when Array:  @color
+    when Hash:  [@color[:cyan] || @color[:c],@color[:magenta] || @color[:m],@color[:yellow] || @color[:y],@color[:black] || @color[:k]]
+    when Array:  @color
     end
     array_to_stack(value.map{|n| n > 1 ? n/100.0: n})+"setcmykcolor"
 
   end
 
 end
-#Espa�o de cor Gray
-class Gray < Color
+#Creates Gray color
+class RGhost::Gray < RGhost::Color
   attr_accessor :gray
-  #Nova inst�ncia de Gray
-  #   Gray.new(0.7)
+  
+  #A single Numeric
+  # Color.create 0.5
+  #50 percent of black will be divided by 100.0
+  # Color.create 50
   def initialize(gray=0.8)
-     @gray=gray
+    @gray=gray
   end
   
-  def ps
-     @gray = @gray/100.0 if @gray > 1
+  def ps #:nodoc:
+    @gray = @gray/100.0 if @gray > 1
     "#{@gray} setgray"
   end