rubyvis 0.1.5 → 0.1.6

data/lib/rubyvis.rb

@@ -11,7 +11,6 @@ require 'rubyvis/nest'
 
 require 'rubyvis/javascript_behaviour'
 require 'rubyvis/format'
-require 'rubyvis/label'
 require 'rubyvis/mark'
 require 'rubyvis/scale'
 require 'rubyvis/color/color'
@@ -22,22 +21,45 @@ require 'rubyvis/layout'
 require 'rubyvis/scene/svg_scene'
 require 'rubyvis/transform'
 
-def pv
-  Rubyvis
-end
 
 module Rubyvis
   @document=nil
-  VERSION = '0.1.5'
+  # Rubyvis version
+  VERSION = '0.1.6' 
+  # Protovis API on which current Rubyvis is based
   API_VERSION='3.3'
-  Infinity=1.0 / 0 # You actually can do it! http://snipplr.com/view/2137/uses-for-infinity-in-ruby/
+  # You actually can do it! http://snipplr.com/view/2137/uses-for-infinity-in-ruby/
+  Infinity=1.0 / 0 
+  #
   # :section: basic methods
+  #
+  
+  # Returns the passed-in argument, +x+; the identity function. This method
+  # is provided for convenience since it is used as the default behavior for a
+  # number of property functions.
+  #
+  # @param [Object] x, a value.
+  # @return [Object] the value +x+.
   def self.identity
     lambda {|x,*args| x}
   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:
+ #
+ # <pre>.fill_style(Rubyvis::Colors.category10().by(Rubyvis.index))</pre>
+ #
+ # This method is equivalent to <tt>lambda {self.index}</tt>, but more
+ # succinct. Note that the <tt>index</tt> property is also supported for
+ # accessor functions with {@link Rubyvis.max}, {@link Rubyvis.min} and other array
+ # utility methods.
+ #
+ # @see Rubyvis::Scale
+ # @see Rubyvis::Mark#index
   def self.index
     lambda {|*args| self.index}
   end
+  
   def self.child
     lambda {|*args| self.child_index}
   end
@@ -61,3 +83,10 @@ module Rubyvis
     s
   end
 end
+
+# Alias for Rubyvis module
+# @return [Module] Rubyvis module
+def pv
+  Rubyvis
+end
+

data/spec/anchor_spec.rb

@@ -49,22 +49,22 @@ describe Rubyvis::Anchor do
     adatas=[]
     s = 180
     _p = 20
-    vis = pv.Panel.new()
-    .height(s * antibiotics.size + _p * (antibiotics.size - 1))
-    .width(s * antibiotics.size + _p * (antibiotics.size - 1))
-    .top(14.5)
-    .left(14.5)
-    .bottom(44)
-    .right(14)
+    vis = pv.Panel.new().
+      height(s * antibiotics.size + _p * (antibiotics.size - 1)).
+      width(s * antibiotics.size + _p * (antibiotics.size - 1)).
+      top(14.5).
+      left(14.5).
+      bottom(44).
+      right(14)
 
-    cell = vis.add(pv.Panel)
-    .data(a1)
-    .width(s)
-    .left(lambda {(s + _p) * self.index})
-  .add(pv.Panel)
-    .data(a2)
-    .height(s)
-    .top(lambda {(s + _p) * self.index});
+    cell = vis.add(pv.Panel).
+      data(a1).
+      width(s).
+      left(lambda {(s + _p) * index}).
+    add(pv.Panel).
+      data(a2).
+      height(s).
+      top(lambda {(s + _p) * self.index});
 
     
     cell.anchor("center").add(pv.Label).text(lambda {|*args| adatas.push args})

data/web/Rakefile

@@ -0,0 +1,34 @@
+# -*- ruby -*-
+require 'rake'
+def get_base(f)
+  f.sub(File.dirname(__FILE__)+"/../examples/","").gsub("/","_").gsub(".rb","")
+end
+directory "examples"
+EXAMPLES=Dir.glob(File.dirname(__FILE__)+"/../examples/**/*.rb").map {|v|     [v,get_base(v)]
+}.find_all{|v| !v[0].include?"_data"}
+
+EXAMPLES_BASE=EXAMPLES.map {|v| v[1]}
+
+
+
+task :build_site do
+  ruby "build_site.rb"
+end
+
+task :default=>["index.html"]+EXAMPLES_BASE.map {|v| "examples/#{v}.html"}
+
+
+file "index.html"=>["index.haml", :build_site]+EXAMPLES_BASE.map {|v| "examples/#{v}.png"}
+
+EXAMPLES.each do |v|
+  e=v[1]
+  file "examples/#{e}.html"=>["examples.haml", :build_site, v[0]]
+  file "examples/#{e}.svg"=>[v[0]] do |t|
+    system "ruby1.9 #{v[0]} > #{t.name}"
+  end
+  file "examples/#{e}.png"=>"examples/#{e}.svg" do |t|
+  system   "rsvg  -w 200 -h 200 -f png examples/#{e}.svg #{t.name}"
+  end
+end
+
+load 'upload_task.rb' if File.exists? "upload_task.rb"

data/web/build_site.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/ruby
+# * Create the index
+# * Create an html page for each example
+$:.unshift("../lib")
+require 'coderay'
+require 'haml'
+require 'ostruct'
+require 'rubyvis'
+
+# First, create the examples
+
+haml_template=Haml::Engine.new(File.read("examples.haml"))
+buffer=[]
+
+def get_base(f)
+  f.sub(File.dirname(__FILE__)+"/../examples/","").gsub("/","_").gsub(".rb","")
+end
+
+# Store prev and next element
+pages={}
+prev_page=nil
+next_page=nil
+
+Dir.glob(File.dirname(__FILE__)+"/../examples/**/*.rb") do |f|
+  
+  next if f.include? "_data.rb"
+  fn=get_base(f)
+  unless prev_page.nil?
+    pages[prev_page].next_ex = fn
+  end
+     
+  pages[fn]=OpenStruct.new({:prev_ex=>prev_page, :next_ex=>next_page, :name=>fn})
+  
+  prev_page=fn
+  
+  base=fn
+  
+  page=pages[fn]
+  mtime=File.mtime(f)
+  next if f.include? "_data.rb"
+  # First, get name and text
+  fp=File.open(f,"r")
+  comment=false
+  title=File.basename(f)
+  text=[]
+  source_a=[]
+  previous_example=""
+  next_example=""
+  fp.each do |line|
+    if line=~/\s*#\s*(.+)/ and !comment
+      t=$1
+      if t=~ /=\s*(.+)/
+        title=$1
+      else
+        text << t
+      end
+    else
+      comment=true
+      source_a << line unless line.include? "$:.unshift"
+    end
+  end
+  text.map! {|t| t.chomp}
+  # Create an html file with svg included inside
+  page.source=CodeRay.scan(source_a.join(), :ruby).div
+  page.title=title
+  page.text=text
+  page.svg_file=base+".svg"
+   
+end
+
+pages.each do |name,page|
+  html_file="examples/#{page.name}.html"
+  File.open(html_file,"w") {|fp|
+    fp.write(haml_template.render(page, :pages=>pages))
+  }
+  
+end
+
+
+
+# Create index
+
+index_template=Haml::Engine.new(File.read("index.haml"))
+File.open("index.html","w") {|fp|
+  fp.write(index_template.render(self,:examples=>pages))
+}

data/web/examples.haml

@@ -0,0 +1,26 @@
+!!!
+%html
+  %head
+    %link{:type=>"text/css", :rel=>"stylesheet", :href=>"../style.css"}
+    %title="Rubyvis - Example: #{title}"
+  %body
+    %h1="Rubyvis - Example: #{title}"
+    .example_main
+      .description
+        - text.each do |t|
+          %p= t
+      .navigation
+        %ul
+          %li 
+            %a{:href=>"../index.html"} Home
+          - if prev_ex
+            %li
+              %a{:href=>"#{prev_ex}.html"} Previous: #{pages[prev_ex].title}
+          - if next_ex
+            %li
+              %a{:href=>"#{next_ex}.html"} Next: #{pages[next_ex].title}          
+      .image
+        /[if IE]
+          %embed.svg{:src=>svg_file,:width=>"500", :height=>"300"}
+        %object.svg{:data=>svg_file, :type=>"image/svg+xml"}
+      .source=find_and_preserve(source)

data/web/index.haml

@@ -0,0 +1,97 @@
+!!!
+%html
+  %head
+    %link{:type=>"text/css", :rel=>"stylesheet", :href=>"style.css"}
+    %title Rubyvis: Ruby version of Protovis
+  %body
+    %h1 Rubyvis
+    %h2 Description
+    .description
+      %p 
+        Ruby port of 
+        %a{:href=>"http://vis.stanford.edu/protovis/"} Protovis library
+        According to the protovis site
+        %blockquote
+          Protovis composes custom views of data with simple marks such as bars and dots. Unlike low-level graphics libraries that quickly become tedious for visualization, Protovis defines marks through dynamic properties that encode data, allowing inheritance, scales and layouts to simplify construction.
+        %p As Protovis, Rubyvis is free and open-source, provided under the BSD License. Its delivers SVG natively, which could be exported to PNG, JPEG and others graphics formats 
+        %p 
+          Current Version:
+          %strong=Rubyvis::VERSION
+        %p 
+          Protovis API Version:
+          %strong=Rubyvis::API_VERSION
+    %h2 Installation
+    %pre gem install rubyvis
+    %h2 Synopsis
+    .synopsis
+      #ruby_code
+        %h3 Ruby
+        %pre 
+          :preserve
+            require 'rubyvis'
+            vis = Rubyvis::Panel.new.width(150).height(150);
+            vis.add(pv.Bar).data([1, 1.2, 1.7, 1.5, 0.7, 0.3]).
+              width(20).
+              height(lambda {|d| d * 80}).
+              bottom(0).
+              left(lambda {self.index * 25})
+            vis.render()
+      #svg_code
+        %h3 SVG
+        %pre
+          :preserve
+            <svg fill="none" font-family="sans-serif" 
+            font-size="10px" height="150.0" stroke="none" 
+            stroke-width="1.5" width="150.0">
+            <g transform="translate(0.0,0.0)">
+            <rect fill="rgb(31,119,180)" height="80" 
+            width="20" y="70"/>
+            <rect fill="rgb(31,119,180)" height="96.0" 
+            width="20" x="25" y="54.0"/>
+            <rect fill="rgb(31,119,180)" height="136.0" 
+            width="20" x="50" y="14.0"/>
+            <rect fill="rgb(31,119,180)" height="120.0" 
+            width="20" x="75" y="30.0"/>
+            <rect fill="rgb(31,119,180)" height="56.0" 
+            width="20"  x="100" y="94.0"/>
+            <rect fill="rgb(31,119,180)" height="24.0" 
+            width="20" x="125" y="126.0"/>
+            </g>
+            </svg>
+      #image
+        %div
+          %h3 Image
+          /[if IE]
+            %embed{:src=>"examples/first.svg" ,:width=>"150", :height=>"150"}
+          %object{:data=>"examples/first.svg", :type=>"image/svg+xml", :width=>150,:height=>150}
+    .examples_div
+      %h2 Examples
+      %p 
+        Several based on
+        %a{:href=>"http://vis.stanford.edu/protovis/ex/"}Protovis gallery
+      .examples
+        - examples.each_pair do |name,page|
+          .example
+            .name
+              %a{:href=>"examples/"+name+".html"}=page.title
+            .image
+              %img{:src=>"examples/"+name+".png"}
+    .resources
+      %h2 Resources
+      %ul
+        %li
+          source code on
+          %a{:href=>'http://github.com/clbustos/rubyvis'}
+            Github
+        %li
+          requests and bug reports on 
+          %a{:href=>'http://github.com/clbustos/rubyvis/issues'}
+            Github, too
+        %li
+          gem on 
+          %a{:href=>'http://rubygems.org/gems/rubyvis'}
+            gemcutter
+        %li
+          API documentation on 
+          %a{:href=>'http://rubyvis.rubyforge.org/rubyvis/'}
+            http://rubyvis.rubyforge.org/rubyvis/

data/web/style.css

@@ -0,0 +1,82 @@
+body {
+  background-color: white;
+  color: black;
+  padding: 0;
+  font-family: "Arial",sans-serif;
+}
+
+h1,h2,h3 {
+	color:#600;
+}
+
+.example .name {
+text-align:center;
+margin-bottom:0.5em;
+}
+
+.example .image {
+}
+
+.example {
+float:left;
+border:1px solid #ccc;
+padding:1em;
+margin:1em;
+}
+
+.description {
+    border:1px solid #dcc;
+    background: #ffefef;
+    padding:0.5em;
+    margin-bottom:1em;
+}
+
+.examples_div, .resources {
+    clear:both;
+}
+#image {
+    float:left;
+    width:auto; 
+    font-size:8pt;
+    margin:1em;
+    padding:0.5em 1em;
+    border:1px solid #ccc;
+    height:auto;
+
+}
+#ruby_code, #svg_code {
+    float:left;
+    width:30%;
+    font-size:8pt;
+    margin:1em;
+    padding:0.5em;
+    border:1px solid #ccc;
+    height:auto;
+}
+
+.synopsis h3 {
+    font-size:12pt;
+    text-align:center;
+}
+
+.example_main .description {
+clear:both;
+}
+.example_main .image {
+    float:left;
+}
+
+.navigation {
+    font-size:80%;
+    margin: 0.2em 0em 2em 2em;
+}
+.navigation ul {
+    list-style:none;
+}
+.example_main .source {
+    float:right;
+    width:40%;
+    margin: 0.5em 1em;
+    border:1px solid #ccc;
+    padding:1em;
+}

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Claudio Bustos
@@ -35,7 +35,7 @@ cert_chain:
   rpP0jjs0
   -----END CERTIFICATE-----
 
-date: 2010-10-22 00:00:00 -03:00
+date: 2010-10-30 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,7 +66,7 @@ dependencies:
         version: 2.6.2
   type: :development
   version_requirements: *id002
-description: Ruby port of Protovis, a great visualization toolkit
+description: Ruby port of Protovis[http://vis.stanford.edu/protovis/], a great visualization toolkit
 email: 
 - clbustos_at_gmail.com
 executables: []
@@ -88,7 +88,7 @@ files:
 - examples/bar_column_chart.rb
 - examples/barley/barley.rb
 - examples/barley/barley_data.rb
-- examples/crimea/crimea.rb
+- examples/crimea/crimea_data.rb
 - examples/crimea/crimea_grouped_bar.rb
 - examples/crimea/crimea_line.rb
 - examples/dot.rb
@@ -96,6 +96,7 @@ files:
 - examples/grouped_charts.rb
 - examples/line.rb
 - examples/line_and_step.rb
+- examples/nested_grid.rb
 - examples/pie_and_donut.rb
 - examples/scatterplot.rb
 - examples/second.rb
@@ -110,7 +111,6 @@ files:
 - lib/rubyvis/format/number.rb
 - lib/rubyvis/internals.rb
 - lib/rubyvis/javascript_behaviour.rb
-- lib/rubyvis/label.rb
 - lib/rubyvis/layout.rb
 - lib/rubyvis/layout/stack.rb
 - lib/rubyvis/mark.rb
@@ -141,6 +141,7 @@ files:
 - lib/rubyvis/scene/svg_wedge.rb
 - lib/rubyvis/sceneelement.rb
 - lib/rubyvis/transform.rb
+- spec/anchor_spec.rb
 - spec/bar_spec.rb
 - spec/internal_spec.rb
 - spec/javascript_behaviour_spec.rb
@@ -150,6 +151,7 @@ files:
 - spec/panel_spec.rb
 - spec/scale_linear_datetime_spec.rb
 - spec/scale_linear_spec.rb
+- spec/scale_log_spec.rb
 - spec/scale_ordinal_spec.rb
 - spec/scale_spec.rb
 - spec/spec.opts
@@ -248,8 +250,11 @@ files:
 - vendor/protovis/src/text/Format.js
 - vendor/protovis/src/text/NumberFormat.js
 - vendor/protovis/src/text/TimeFormat.js
-- web/first.svg
-- web/index.html
+- web/Rakefile
+- web/build_site.rb
+- web/examples.haml
+- web/index.haml
+- web/style.css
 has_rdoc: true
 homepage: http://rubyvis.rubyforge.org/
 licenses: []
@@ -280,7 +285,7 @@ rubyforge_project: rubyvis
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Ruby port of Protovis, a great visualization toolkit
+summary: Ruby port of Protovis[http://vis.stanford.edu/protovis/], a great visualization toolkit
 test_files: 
 - spec/bar_spec.rb
 - spec/nest_spec.rb

data/lib/rubyvis/label.rb

@@ -1 +0,0 @@
-

data/web/first.svg

@@ -1 +0,0 @@
-<svg fill='none' font-family='sans-serif' font-size='10px' height='150.0' stroke='none' stroke-width='1.5' xmlns:svg='http://www.w3.org/2000/svg' width='150.0'><g transform='translate(0.0,0.0)'><rect fill='rgb(31,119,180)' height='80' width='20' y='70'/><rect fill='rgb(31,119,180)' height='96.0' width='20' x='25' y='54.0'/><rect fill='rgb(31,119,180)' height='136.0' width='20' x='50' y='14.0'/><rect fill='rgb(31,119,180)' height='120.0' width='20' x='75' y='30.0'/><rect fill='rgb(31,119,180)' height='56.0' width='20' x='100' y='94.0'/><rect fill='rgb(31,119,180)' height='24.0' width='20' x='125' y='126.0'/></g><g transform='translate(0.0,0.0)'/></svg>

data/web/index.html

@@ -1,48 +0,0 @@
-<html>
-<head>
-<title>Rubyvis: Ruby version of Protovis</title>
-</head>
-<body>
-<h1>Rubyvis</h1>
-<h2>Ruby version of Protovis</h2>
-</body>
-<ul>
-<li>original <a href='http://vis.stanford.edu/protovis/'>protovis</a></li>
-<li>source code on <a href='http://github.com/clbustos/rubyvis'>Github</a></li>
-<li>gem on <a href='http://rubygems.org/gems/rubyvis'>gemcutter</a></li>
-<li>documentation on <a href='http://rubyvis.rubyforge.org/rubyvis/'>http://rubyvis.rubyforge.org/rubyvis/</a></li>
-</ul>
-<p>this code</p>
-<pre>
-require 'rubyvis'
-vis = Rubyvis::Panel.new.width(150).height(150);
-
-vis.add(pv.Bar).data([1, 1.2, 1.7, 1.5, 0.7, 0.3]).
-  width(20).
-  height(lambda {|d| d * 80}).
-  bottom(0).
-  left(lambda {self.index * 25})
-vis.render()
-</pre>
-
-<p>Returns this svg code</p>
-<pre>
-&lt;svg fill="none" font-family="sans-serif" font-size="10px" height="150.0" stroke="none" stroke-width="1.5" width="150.0"&gt;
-&lt;g transform="translate(0.0,0.0)"&gt;
-&lt;rect fill="rgb(31,119,180)" height="80" width="20" y="70"/&gt;
-&lt;rect fill="rgb(31,119,180)" height="96.0" width="20" x="25" y="54.0"/&gt;
-&lt;rect fill="rgb(31,119,180)" height="136.0" width="20" x="50" y="14.0"/&gt;
-&lt;rect fill="rgb(31,119,180)" height="120.0" width="20" x="75" y="30.0"/&gt;
-&lt;rect fill="rgb(31,119,180)" height="56.0" width="20" x="100" y="94.0"/&gt;
-&lt;rect fill="rgb(31,119,180)" height="24.0" width="20" x="125" y="126.0"/&gt;
-&lt;/g&gt;
-&lt;/svg&gt;
-</pre>
-
-Which renders
-
-<div>
-
-<!--[if IE]><embed src="first.svg" width="150" height="150"><![endif]-->
-<object data="first.svg" type="image/svg+xml" width="150" height="150" class="svg">
-</object> </html>