rubyvis 0.4.1 → 0.5.0

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.5.0 / 2011-02-04
+* Nokogiri used as XML builder. Fall back to REXML if nokogiri is not available or $rubyvis_no_nokogiri=true
+
+
 === 0.4.1 / 2011-01-26
 * All tests run on ruby 1.8.7. Not all pass, because on ruby<1.9 hash order are not preserved
 * Removed warnings for Ruby 1.9+

data/README.txt

@@ -41,6 +41,8 @@ I try to maintain, when posible, complete compatibility with Javascript API, inc
 
 User could use +pv+ freely, cause is defined as a global method which call Rubyvis.
 
+Nokogiri is used as XML library. If not available, or $rubyvis_no_nokogiri is set to true, REXML is used. Nokogiri is 30%-35% faster that REXML on our test.
+
 == CURRENT PROGRESS
 
 * pv.js

data/Rakefile

@@ -7,7 +7,7 @@ require 'hoe'
 require 'rubyvis'
 require 'rspec'
 require 'rspec/core/rake_task'
-
+require 'rubyforge'
 
 Hoe.plugin :git
 

data/lib/rubyvis/mark/panel.rb

@@ -77,11 +77,17 @@ module Rubyvis
     end
 
     def to_svg
-      @_canvas.sort.map {|v|
-        bar = REXML::Formatters::Default.new
-        out = String.new
-        bar.write(v[1].elements[1], out)
-      }.join
+      if Rubyvis.xml_engine==:nokogiri
+        @_canvas.sort.map {|v|
+          v[1].get_element(1).to_xml(:indent => 5, :encoding => 'UTF-8')
+        }.join
+      else
+        @_canvas.sort.map {|v|
+          bar = REXML::Formatters::Default.new
+          out = String.new
+          bar.write(v[1].elements[1], out)
+        }.join
+      end
     end
     def build_implied(s)
       panel_build_implied(s)
@@ -107,8 +113,15 @@ module Rubyvis
           @_canvas||={}
           cache=@_canvas
           if(!(c=cache[self.index]))
+          
+          if Rubyvis.xml_engine==:nokogiri
+            document=Nokogiri::XML::Document.new
+            document.root=document.create_element('document')
+            Rubyvis.nokogiri_document(document)
+          else
             document=REXML::Document.new
-            document.add_element("document")
+            document.add_element("document")            
+          end
             cache[self.index]=document.root
             c=cache[self.index]
             

data/lib/rubyvis/scene/svg_area.rb

@@ -1,7 +1,8 @@
 module Rubyvis
   module SvgScene
     def self.area(scenes)
-      e = scenes._g.elements[1]
+      #e = scenes._g.elements[1]
+      e=scenes._g.get_element(1)
       return e if scenes.size==0
       s=scenes[0]
       # segmented
@@ -127,7 +128,8 @@ module Rubyvis
     end
         
     def self.area_segment(scenes)
-      e = scenes._g.elements[1]
+      e=scenes._g.get_element(1)
+      #e = scenes._g.elements[1]
       s = scenes[0]
       pathsT=nil
       pathsB=nil

data/lib/rubyvis/scene/svg_bar.rb

@@ -1,13 +1,14 @@
 module Rubyvis
   module SvgScene
     def self.bar(scenes)
-      e=scenes._g.elements[1]
+      #e=scenes._g.elements[1]
+      e=scenes._g.get_element(1)
       scenes.each_with_index do |s,i|
         next unless s.visible
         fill=s.fill_style
         stroke=s.stroke_style
         next if(fill.opacity==0 and stroke.opacity==0)
-        e=SvgScene.expect(e,'rect', {
+        e=SvgScene.expect(e, 'rect', {
           "shape-rendering"=> s.antialias ? nil : "crispEdges",
           "pointer-events"=> s.events,
           "cursor"=> s.cursor,

data/lib/rubyvis/scene/svg_dot.rb

@@ -1,7 +1,8 @@
 module Rubyvis
   module SvgScene
     def self.dot(scenes)
-      e = scenes._g.elements[1]
+      #e = scenes._g.elements[1]
+      e=scenes._g.get_element(1)
       scenes.each_with_index {|s,i|
       s = scenes[i];
       

data/lib/rubyvis/scene/svg_image.rb

@@ -1,7 +1,8 @@
 module Rubyvis
   module SvgScene
     def self.image(scenes)
-      e=scenes._g.elements[1]
+      #e=scenes._g.elements[1]
+      e=scenes._g.get_element(1)
       scenes.each_with_index do |s,i|
         next unless s.visible
         e=self.fill(e,scenes,i)

data/lib/rubyvis/scene/svg_label.rb

@@ -1,7 +1,8 @@
 module Rubyvis
   module SvgScene
     def self.label(scenes)
-      e=scenes._g.elements[1]
+      #e=scenes._g.elements[1]
+      e=scenes._g.get_element(1)
       scenes.each_with_index do |s,i|
         next unless s.visible
         fill=s.text_style

data/lib/rubyvis/scene/svg_line.rb

@@ -1,7 +1,8 @@
 module Rubyvis
   module SvgScene
     def self.line(scenes)
-      e=scenes._g.elements[1]
+      #e=scenes._g.elements[1]
+      e=scenes._g.get_element(1)
       return e if (scenes.size < 2)
       s = scenes[0]
       # segmented */
@@ -50,8 +51,8 @@ module Rubyvis
 
     def self.line_segment(scenes)
 
-      e=scenes._g.elements[1]
-
+      #e=scenes._g.elements[1]
+      e=scenes._g.get_element(1)
       s = scenes[0];
       paths=nil
       case s.interpolate

data/lib/rubyvis/scene/svg_panel.rb

@@ -3,44 +3,70 @@ module Rubyvis
     def self.panel(scenes)
       puts " -> panel: #{scenes.inspect}" if $DEBUG
       g=scenes._g
-      e=(g.nil?) ? nil : g.elements[1]
+      #e=(g.nil?) ? nil : g.elements[1]
+      e=(g.nil?) ? nil : g.get_element(1) 
       if g
-        e=g.elements[1]
+        #e=g.elements[1]
+        e=g.get_element(1)
       end
       scenes.each_with_index do |s,i|
         next unless s.visible
 
         if(!scenes.parent)
           if g and g.parent!=s.canvas
-            g=s.canvas.elements[1]
-            e=(@g.nil?) ? nil : @g.elements[1]
+            #g=s.canvas.elements[1]
+            g=s.canvas.get_element(1)
+            #e=(@g.nil?) ? nil : @g.elements[1]
+            e=(@g.nil?) ? nil : @g.get_element(1)
           end
           if(!g)
             g=s.canvas.add_element(self.create('svg'))
-            g.attributes["font-size"]="10px"
-            g.attributes["font-family"]="sans-serif"
-            g.attributes["fill"]="none"
-            g.attributes["stroke"]="none"
-            g.attributes["stroke-width"]=1.5
-            e=g.elements[1]
+            g.set_attributes(
+              {
+                'font-size'=>"10px",
+                'font-family'=>'sans-serif',
+                'fill'=>'none',
+                'stroke'=>'none',
+                'stroke-width'=>1.5
+              }
+            )
+            e=g.get_element(1)
+            # g.attributes["font-size"]="10px"
+            # g.attributes["font-family"]="sans-serif"
+            # g.attributes["fill"]="none"
+            # g.attributes["stroke"]="none"
+            # g.attributes["stroke-width"]=1.5
+            # e=g.elements[1]
           end
           scenes._g=g
           #p s
-          g.attributes['width']=s.width+s.left+s.right
-          g.attributes['height']=s.height+s.top+s.bottom
+          g.set_attributes({
+              'width'=>s.width+s.left+s.right,
+              'height'=>s.height+s.top+s.bottom
+          })
+          #g.attributes['width']=s.width+s.left+s.right
+          #g.attributes['height']=s.height+s.top+s.bottom
         end
         if s.overflow=='hidden'
           id=Rubyvis.id.to_s(36)
           c=self.expect(e,'g',{'clip-path'=>'url(#'+id+')'});
           g.add_element(c) if(!c.parent)
           scenes._g=g=c
-          e=c.elements[1]
+          #e=c.elements[1]
+          e=c.get_element(1)
           e=self.expect(e,'clipPath',{'id'=>id})
-          r=(e.elements[1]) ? e.elements[1] : e.add_element(self.create('rect'))
-          r.attributes['x']=s.left
-          r.attributes['y']=s.top
-          r.attributes['width']=s.width
-          r.attributes['height']=s.height
+          #r=(e.elements[1]) ? e.elements[1] : e.add_element(self.create('rect'))
+          r=(e.get_element(1)) ? e.get_element(1) : e.add_element(self.create('rect'))
+          r.set_attributes({
+              'x'=>s.left,
+              'y'=>s.top,
+              'width'=>s.width,
+              'height'=>s.height
+          })
+          #r.attributes['x']=s.left
+          #r.attributes['y']=s.top
+          #r.attributes['width']=s.width
+          #r.attributes['height']=s.height
           g.add_element(e) if !e.parent
           e=e.next_sibling_node
 

data/lib/rubyvis/scene/svg_rule.rb

@@ -1,7 +1,8 @@
 module Rubyvis
   module SvgScene
     def self.rule(scenes)
-      e=scenes._g.elements[1]
+      #e=scenes._g.elements[1]
+      e=scenes._g.get_element(1)
       scenes.each_with_index do |s,i|
         next unless s.visible
         stroke=s.stroke_style

data/lib/rubyvis/scene/svg_scene.rb

@@ -11,6 +11,51 @@ require 'rubyvis/scene/svg_curve'
 
 class REXML::Element #:nodoc:
   attr_accessor :_scene
+  # 1 number based
+  def get_element(i)
+    elements[i]
+  end
+  def set_attributes(h)
+    h.each do |k,v|
+      attributes[k]=v
+    end
+  end
+  #private :attributes
+  #private :elements
+end
+
+module Nokogiri
+  module XML
+    class Node
+  attr_accessor :_scene
+  def add_element(c)
+    add_child(c)
+  end
+  
+  def set_attributes(h)
+    h.each do |k,v|
+      set_attribute(k,v.to_s)
+    end
+  end
+  def get_element(i)
+    elements[i-1]
+  end
+  #private :elements
+  #private :attributes
+  def next_sibling_node
+    next_sibling
+  end
+  def delete_attribute(name)
+    remove_attribute(name)
+  end
+  def text
+    content
+  end
+  def text=(v)
+    self.content=v
+  end
+  end
+end
 end
 
 module Rubyvis
@@ -67,11 +112,19 @@ module Rubyvis
       end
     end
     def self.create(type)
-      el=REXML::Element.new "#{type}"
-      if type=='svg'
-        el.add_namespace(self.svg)
-        #el.add_namespace("xmlns:xmlns", self.xmlns)
-        el.add_namespace("xmlns:xlink", self.xlink)
+      if Rubyvis.xml_engine==:nokogiri
+        el=Rubyvis.nokogiri_document.create_element("#{type}")
+        if type=='svg'
+          el.add_namespace(nil, self.svg)
+          el.add_namespace('xlink', self.xlink)
+        end
+      else
+        el=REXML::Element.new "#{type}"
+        if type=='svg'
+          el.add_namespace(self.svg)
+          #el.add_namespace("xmlns:xmlns", self.xmlns)
+          el.add_namespace("xmlns:xlink", self.xlink)
+        end
       end
       el
     end
@@ -104,7 +157,9 @@ module Rubyvis
           e.parent.replace_child(a, e) if (e.parent)
           a.add_element(e)
         end
-        a.add_attribute('xlink:title',s.title)
+        #a.add_attribute('xlink:title',s.title)
+        a.set_attributes('xlink:title' => s.title)
+
         return a;
       end
       a.parent_node.replace_child(e, a) if (a) 
@@ -114,7 +169,8 @@ module Rubyvis
     def self.expect(e, type, attributes, style=nil)
 
       if (e)
-        e = e.elements[1] if (e.name == "a")
+        #e = e.elements[1] if (e.name == "a")
+        e=e.get_element(1) if (e.name == 'a')
         if (e.name != type)
           n = self.create(type);
           e.parent.replace_child(e, n);
@@ -128,7 +184,8 @@ module Rubyvis
         if (value.nil?)
           e.delete_attribute(name)
         else
-          e.attributes[name]=value
+          e.set_attributes(name=>value)
+          #e.attributes[name]=value
         end
       }
       
@@ -145,12 +202,12 @@ module Rubyvis
           if (value.nil?)
             array_styles.delete(name)
           else
-            
             array_styles[name]=value
           end
         }
         if array_styles.size>0
-          e.attributes["style"]=array_styles.map {|k,v| "#{k}:#{v}"}.join(";")
+          #e.attributes["style"]=array_styles.map {|k,v| "#{k}:#{v}"}.join(";")
+          e.set_attributes('style'=> array_styles.map {|k,v| "#{k}:#{v}"}.join(";"))
         end
       end
       e

data/lib/rubyvis/scene/svg_wedge.rb

@@ -1,7 +1,8 @@
 module Rubyvis
   module SvgScene
     def self.wedge(scenes)
-      e=scenes._g.elements[1]
+      #e=scenes._g.elements[1]
+      e=scenes._g.get_element(1)
       scenes.each_with_index do |s,i|
         next unless s.visible
         fill=s.fill_style

data/lib/rubyvis.rb

@@ -28,11 +28,13 @@ require 'rubyvis/scene/svg_scene'
 require 'rubyvis/transform'
 require 'rubyvis/mark/shorcut_methods'
 
-
+# = Rubyvis
+# Ruby port of Protovis
+# 
 module Rubyvis
-  @document=nil
+  @@nokogiri=nil
   # Rubyvis version
-  VERSION = '0.4.1' 
+  VERSION = '0.5.0' 
   # Protovis API on which current Rubyvis is based
   PROTOVIS_API_VERSION='3.3'
   # You actually can do it! http://snipplr.com/view/2137/uses-for-infinity-in-ruby/
@@ -50,7 +52,33 @@ module Rubyvis
   def self.identity
     lambda {|x,*args| x}
   end
+  def self.has_nokogiri?
+    if @@nokogiri.nil?
+      begin
+        require 'nokogiri'
+        @@nokogiri=true
+      rescue LoadError
+        @@nokogiri=false
+      end
+    end
+    @@nokogiri
+  end
+  def self.xml_engine
+    if has_nokogiri? and !$rubyvis_no_nokogiri
+      :nokogiri
+    else
+      puts "rexml"
+      :rexml
+    end
+  end
+
   
+  def self.nokogiri_document(v=nil)
+    if !v.nil?
+      @@nokogiri_document=v
+    end
+    @@nokogiri_document
+  end
  # Returns <tt>self.index</tt>. This method is provided for convenience for use
  # with scales. For example, to color bars by their index, say:
  #

data/spec/ruby_api_spec.rb

@@ -1,5 +1,5 @@
 require File.expand_path(File.dirname(__FILE__)+"/spec_helper.rb")
-describe "Ruby API for Rubyvis" do
+shared_examples_for "Ruby API for Rubyvis" do
   before do
     @h=200
     @w=200
@@ -44,4 +44,27 @@ describe "Ruby API for Rubyvis" do
     svg1.should==svg2
     
   end
-end
+end
+
+describe "Rubyvis with REXML" do
+  before(:all) do
+    $rubyvis_no_nokogiri=true
+  end
+  after(:all) do
+    $rubyvis_no_nokogiri=false    
+  end
+  it_should_behave_like "Ruby API for Rubyvis"
+end
+
+if Rubyvis.has_nokogiri? 
+  describe "Rubyvis with Nokogiri" do
+
+    before(:all) do
+      $rubyvis_no_nokogiri=false
+    end
+    
+    it_should_behave_like "Ruby API for Rubyvis"
+
+    
+  end
+end

data/spec/spec_helper.rb

@@ -94,6 +94,7 @@ end
 RSpec::Matchers.define :have_svg_attributes do |exp|
   match do |obs|
     exp.each {|k,v|
+      obs.attributes[k].should be_true
       obs.attributes[k].value.should==v
     }
   end
@@ -193,7 +194,7 @@ Rspec::Matchers.define :have_same_svg_elements do |exp|
     correct
   end
   failure_message_for_should do |obs|
-    "#{@error[:type]}: #{@error[:exp].to_s} expected, but #{@error[:obs]} retrieved, on attr #{@error[:attr]} -> #{@error[:i]} : #{@error[:exp_attr]} <> #{@error[:obs_attr]}"
+    "#{@error[:type]}: #{@error[:exp].to_s} expected, but #{@error[:obs]} retrieved, on #{@error[:attr]} -> #{@error[:i]} : '#{@error[:exp_attr]}' <> '#{@error[:obs_attr]}'"
   end
   
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 1
-  version: 0.4.1
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Claudio Bustos
@@ -35,7 +35,7 @@ cert_chain:
   rpP0jjs0
   -----END CERTIFICATE-----
 
-date: 2011-01-26 00:00:00 -03:00
+date: 2011-02-04 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency